The following sections describe the tasks you need to complete to set up a CI/CD process with Travis CI, your version control system (VCS), and the ActiveState Platform. You need the appropriate access to these systems to complete the setup. In the examples below, we show configuration steps for GitHub specifically. You may need to adjust some of the tasks if you are using a different VCS.
Travis currently provides only limited support for Windows builds, and Windows configuration won’t be covered in this guide. We’ll add details for this configuration when Windows is fully supported on Travis CI.
Before you begin:
state auth
command, in order to run the command to retrieve the API key, and to access your private.key
file if you are using secrets.The State Tool will use the following environment variables if they are defined:
You can obtain an API key by opening a command prompt and running the following State Tool command:
state export new-api-key APIKeyForCI
Example response:
Note that this key is not stored by ActiveState. Please store the value for later use as you cannot retrieve it again.
XYZjMmMwYTgtZWRkOS00ZGRiLThmMWEtNDM4NjlhNzE0MTI0IkNlUnZpQmlQXYZYXYZ
In this example, you would copy the token value on the second line to use as the ACTIVESTATE_API_KEY environment variable in your CI/CD application.
You can find the private key value at <configdir>/activestate/cli-unstable/private.key
.
The configdir varies per platform, but in most cases will be at one of:
%HOME%\AppData\Roaming\activestate\cli-unstable\
~/config/activestate/cli-unstable/
~/Library/Application\ Support/activestate/cli-unstable/
The private key environment variable expects the contents of the private.key
file, not the filepath.
Log in to Travis CI at http://travis-ci.org for public or open-source repositories, or their paid option for private repositories at http://travis-ci.com.
Enable the repository you want to build.
In some cases you may need to escape certain characters in your private key.
You need to open the private.key
file and copy the contents.
-----BEGIN RSA PRIVATE KEY-----
...
3W5OE+S83fcBz1u7pNzgE4UtXJOADW0PtGt7dLnxqxWJbg38mKYMmqwDoD3/HkfH
...
-----END RSA PRIVATE KEY-----
You can use either the Dashboard or the State Tool to create a new project and add the language, platforms, and packages your project requires. Set up your project by:
After you create an ActiveState project, complete the following steps to activate your project and add the configuration file to your code repository, so that the CI/CD has access to it.
state activate <owner/project_name>
. For example: state activate acmetech/python-3-6-6
.activestate.yaml
configuration file to the root directory of your code repository.activestate.yaml
to add any scripts, variables, or secrets you want CI/CD to run or have access to. For more information on these options, see Getting started.activestate.yaml
to the repository and check in your changes.You need to add a .travis.yml
file to the root of your code repository that includes all of the steps required to build, test, and deploy your code. The example provided demonstrates the State Tool-specific steps for installing the State Tool and running scripts that are defined in the activestate.yaml
file for the project.
# Install the State Tool as a dependency.
install:
- sh <(curl -q https://platform.activestate.com/dl/cli/install.sh) -n
before_script:
# Run the linter and tests using the State Tool. Scripts named `lints` and `tests`
# must be defined in your project's activestate.yaml file. The ActiveState
# Platform language runtime is downloaded and virtual environment is activated
# when the first `state run` command is encountered.
# In this case, `state run clean`
script:
- state run clean
- state run which-python
# Turn email notifications off.
notifications:
email: false
The scripts being executed in the .travis.yml
file are defined in the scripts section of the activestate.yaml
file for the project:
scripts:
- name: clean
description: Run the data cleaner script
value: python3 cleaner.py
- name: which-python
description: Determine which python interpreter is being used
language: python3
value: |
import sys
print("Python script running with: ", sys.executable)
If you successfully configured your Travis CI project, you will see a job start and complete successfully each time someone pushes new code changes to the repository.