* Adds Travis CI migration guide * Updated variable syntax * Updated links * Fixed variable * Split into two tables to fix rendering * Removed section about upstream, might not be applicable here * Made formatting more consistent * Added misc edits, "Next steps" section, matrix example * Added small edits * Added updates from review * Edited "Key similarities" intro * Replaced diagram with link to "Learning GitHub Actions" * Moved links into a "Before you begin" section * Added "Parallel job processing" * Added small edits, "Default environment variables" section * Added "Targeting specific branches" * Added "Checking out submodules" * Moved into nested subsection * Updated "Assumptions about language dependencies" * Renamed section * Adds some small edits * Moved all headings down 1 level * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Added updates from review * Added updates from review * Fixed rendering, added small edit * Removed Travis concepts paragraph, as it seems superfluous * Added minor edits * Reframed the "differences" section to rather emphasize Actions features that might distinguish it from others * Reframed additional differences to emphasize Actions capabilities * Small edit * More small edits * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * Revised conditional example * Revised build matrix exmple * Updated python example * Updated examples * Changed example to "Building with Node.js" * Adds fixes from peer review * Added minor edits * Added some finishing touches * Update migrating-from-travis-ci-to-github-actions.md * Small clarification Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
14 KiB
title, intro, redirect_from, versions
| title | intro | redirect_from | versions | |||||
|---|---|---|---|---|---|---|---|---|
| Migrating from Travis CI to GitHub Actions | {% data variables.product.prodname_actions %} and Travis CI share multiple similarities, which helps make it relatively straightforward to migrate to {% data variables.product.prodname_actions %}. |
|
|
Introduction
This guide helps you migrate from Travis CI to {% data variables.product.prodname_actions %}. It compares their concepts and syntax, describes the similarities, and demonstrates their different approaches to common tasks.
Before you start
Before starting your migration to {% data variables.product.prodname_actions %}, it would be useful to become familiar with how it works:
- For a quick example that demonstrates a {% data variables.product.prodname_actions %} job, see "Quickstart for {% data variables.product.prodname_actions %}."
- To learn the essential {% data variables.product.prodname_actions %} concepts, see "Introduction to GitHub Actions."
Comparing job execution
To give you control over when CI tasks are executed, a {% data variables.product.prodname_actions %} workflow uses jobs that run in parallel by default. Each job contains steps that are executed in a sequence that you define. If you need to run setup and cleanup actions for a job, you can define steps in each job to perform these.
Key similarities
{% data variables.product.prodname_actions %} and Travis CI share certain similarities, and understanding these ahead of time can help smooth the migration process.
Using YAML syntax
Travis CI and {% data variables.product.prodname_actions %} both use YAML to create jobs and workflows, and these files are stored in the code's repository. For more information on how {% data variables.product.prodname_actions %} uses YAML, see "Creating a workflow file."
Custom environment variables
Travis CI lets you set environment variables and share them between stages. Similarly, {% data variables.product.prodname_actions %} lets you define environment variables for a step, job, or workflow. For more information, see "Environment variables."
Default environment variables
Travis CI and {% data variables.product.prodname_actions %} both include default environment variables that you can use in your YAML files. For {% data variables.product.prodname_actions %}, you can see these listed in "Default environment variables."
Parallel job processing
Travis CI can use stages to run jobs in parallel. Similarly, {% data variables.product.prodname_actions %} runs jobs in parallel. For more information, see "Creating dependent jobs."
Status badges
Travis CI and {% data variables.product.prodname_actions %} both support status badges, which let you indicate whether a build is passing or failing. For more information, see "Adding a workflow status badge to your repository."
Using a build matrix
Travis CI and {% data variables.product.prodname_actions %} both support a build matrix, allowing you to perform testing using combinations of operating systems and software packages. For more information, see "Using a build matrix."
Below is an example comparing the syntax for each system:
| Travis CI | {% data variables.product.prodname_actions %} |
|---|---|
| {% raw %} ```yaml matrix: include: - rvm: 2.5 - rvm: 2.6.3 ``` {% endraw %} | {% raw %} ```yaml jobs: build: strategy: matrix: ruby: [2.5, 2.6.3] ``` {% endraw %} |
Targeting specific branches
Travis CI and {% data variables.product.prodname_actions %} both allow you to target your CI to a specific branch. For more information, see "Workflow syntax for GitHub Actions."
Below is an example of the syntax for each system:
| Travis CI | {% data variables.product.prodname_actions %} |
|---|---|
| {% raw %} ```yaml branches: only: - main - 'mona/octocat' ``` {% endraw %} | {% raw %} ```yaml on: push: branches: - main - 'mona/octocat' ``` {% endraw %} |
Checking out submodules
Travis CI and {% data variables.product.prodname_actions %} both allow you to control whether submodules are included in the repository clone.
Below is an example of the syntax for each system:
| Travis CI | {% data variables.product.prodname_actions %} |
|---|---|
| {% raw %} ```yaml git: submodules: false ``` {% endraw %} | {% raw %} ```yaml - uses: actions/checkout@v2 with: submodules: false ``` {% endraw %} |
Key features in {% data variables.product.prodname_actions %}
When migrating from Travis CI, consider the following key features in {% data variables.product.prodname_actions %}:
Storing secrets
{% data variables.product.prodname_actions %} allows you to store secrets and reference them in your jobs. {% data variables.product.prodname_actions %} also includes policies that allow you to limit access to secrets at the repository and organization level. For more information, see "Encrypted secrets."
Sharing files between jobs and workflows
{% data variables.product.prodname_actions %} includes integrated support for artifact storage, allowing you to share files between jobs in a workflow. You can also save the resulting files and share them with other workflows. For more information, see "Sharing data between jobs."
Hosting your own runners
If your jobs require specific hardware or software, {% data variables.product.prodname_actions %} allows you to host your own runners and send your jobs to them for processing. {% data variables.product.prodname_actions %} also lets you use policies to control how these runners are accessed, granting access at the organization or repository level. For more information, see "Hosting your own runners."
Concurrent jobs and execution time
The concurrent jobs and workflow execution times in {% data variables.product.prodname_actions %} can vary depending on your {% data variables.product.company_short %} plan. For more information, see "Usage limits, billing, and administration."
Using different languages in {% data variables.product.prodname_actions %}
When working with different languages in {% data variables.product.prodname_actions %}, you can create a step in your job to set up your language dependencies. For more information about working with a particular language, see the specific guide:
- Building and testing Node.js
- Building and testing PowerShell
- Building and testing Python
- Building and testing Java with Maven
- Building and testing Java with Gradle
- Building and testing Java with Ant
Executing scripts
{% data variables.product.prodname_actions %} can use run steps to run scripts or shell commands. To use a particular shell, you can specify the shell type when providing the path to the script. For more information, see "Workflow syntax for {% data variables.product.prodname_actions %}."
For example:
steps:
- name: Run build script
run: ./.github/scripts/build.sh
shell: bash
Error handling in {% data variables.product.prodname_actions %}
When migrating to {% data variables.product.prodname_actions %}, there are different approaches to error handling that you might need to be aware of.
Script error handling
{% data variables.product.prodname_actions %} stops a job immediately if one of the steps returns an error code. For more information, see "Workflow syntax for {% data variables.product.prodname_actions %}."
Job error handling
{% data variables.product.prodname_actions %} uses if conditionals to execute jobs or steps in certain situations. For example, you can run a step when another step results in a failure(). For more information, see "Workflow syntax for {% data variables.product.prodname_actions %}." You can also use continue-on-error to prevent a workflow run from stopping when a job fails.
Migrating syntax for conditionals and expressions
To run jobs under conditional expressions, Travis CI and {% data variables.product.prodname_actions %} share a similar if condition syntax. {% data variables.product.prodname_actions %} lets you use the if conditional to prevent a job or step from running unless a condition is met. For more information, see "Context and expression syntax for {% data variables.product.prodname_actions %}."
This example demonstrates how an if conditional can control whether a step is executed:
jobs:
conditional:
runs-on: ubuntu-latest
steps:
- run: echo "This step runs with str equals 'ABC' and num equals 123"
if: env.str == 'ABC' && env.num == 123
Migrating phases to steps
Where Travis CI uses phases to run steps, {% data variables.product.prodname_actions %} has steps which execute actions. You can find prebuilt actions in the {% data variables.product.prodname_marketplace %}, or you can create your own actions. For more information, see "Building actions."
Below is an example of the syntax for each system:
| Travis CI | {% data variables.product.prodname_actions %} |
|---|---|
|
{% raw %}
```yaml
language: python
python:
- "3.7"
script:
{% endraw %} |
Caching dependencies
Travis CI and {% data variables.product.prodname_actions %} let you manually cache dependencies for later reuse. This example demonstrates the cache syntax for each system.
| Travis CI | GitHub Actions |
|---|---|
| {% raw %} ```yaml language: node_js cache: npm ``` {% endraw %} | {% raw %} ```yaml - name: Cache node modules uses: actions/cache@v2 with: path: ~/.npm key: v1-npm-deps-${{ hashFiles('**/package-lock.json') }} restore-keys: v1-npm-deps- ``` {% endraw %} |
For more information, see "Caching dependencies to speed up workflows."
Examples of common tasks
This section compares how {% data variables.product.prodname_actions %} and Travis CI perform common tasks.
Configuring environment variables
You can create custom environment variables in a {% data variables.product.prodname_actions %} job. For example:
| Travis CI | {% data variables.product.prodname_actions %} Workflow |
|---|---|
|
|
Building with Node.js
| Travis CI | {% data variables.product.prodname_actions %} Workflow |
|---|---|
| {% raw %} ```yaml install: - npm install script: - npm run build - npm test ``` {% endraw %} | {% raw %} ```yaml name: Node.js CI on: [push] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Use Node.js uses: actions/setup-node@v1 with: node-version: '12.x' - run: npm install - run: npm run build - run: npm test ``` {% endraw %} |
Next steps
To continue learning about the main features of {% data variables.product.prodname_actions %}, see "Learn {% data variables.product.prodname_actions %}."