About GitHub Actions Importer
Supported CI platforms
-
Azure DevOps -
Bamboo -
Bitbucket Pipelines -
CircleCI -
GitLab -
Jenkins -
Travis CI
Prerequisites
-
An environment where you can run Linux-based containers, and can install the necessary tools. -
Docker is installed and running. -
GitHub CLI is installed.
Note : The GitHub Actions Importer container and CLI do not need to be installed on the same server as your CI platform. -
Installing the GitHub Actions Importer CLI extension
-
Install the GitHub Actions Importer CLI extension: Bash gh extension install github/gh-actions-importer gh extension install github/gh-actions-importer -
Verify that the extension is installed: $ gh actions-importer -h Options: -?, - h, -- help Show help and usage information Commands: update Update to the latest version of GitHub Actions Importer. version Display the version of GitHub Actions Importer. configure Start an interactive prompt to configure credentials used to authenticate with your CI server(s). audit Plan your CI/CD migration by analyzing your current CI/CD footprint. forecast Forecast GitHub Actions usage from historical pipeline utilization. dry-run Convert a pipeline to a GitHub Actions workflow and output its yaml file. migrate Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.
Updating the GitHub Actions Importer CLI
gh actions-importer update
Authenticating at the command line
gh actions-importer configure
Using the GitHub Actions Importer CLI
Auditing your existing CI pipelines
$ gh actions-importer audit -h Description: Plan your CI/CD migration by analyzing your current CI/CD footprint. [...] Commands: azure-devops An audit will output a list of data used in an Azure DevOps instance. bamboo An audit will output a list of data used in a Bamboo instance. circle-ci An audit will output a list of data used in a CircleCI instance. gitlab An audit will output a list of data used in a GitLab instance. jenkins An audit will output a list of data used in a Jenkins instance. travis-ci An audit will output a list of data used in a Travis CI instance.
Forecasting usage
$ gh actions-importer forecast -h Description: Forecasts GitHub Actions usage from historical pipeline utilization. [...] Commands: azure-devops Forecasts GitHub Actions usage from historical Azure DevOps pipeline utilization. bamboo Forecasts GitHub Actions usage from historical Bamboo pipeline utilization. jenkins Forecasts GitHub Actions usage from historical Jenkins pipeline utilization. gitlab Forecasts GitHub Actions usage from historical GitLab pipeline utilization. circle-ci Forecasts GitHub Actions usage from historical CircleCI pipeline utilization. travis-ci Forecasts GitHub Actions usage from historical Travis CI pipeline utilization. github Forecasts GitHub Actions usage from historical GitHub pipeline utilization.
Testing the migration process
$ gh actions-importer dry-run -h Description: Convert a pipeline to a GitHub Actions workflow and output its yaml file. [...] Commands: azure-devops Convert an Azure DevOps pipeline to a GitHub Actions workflow and output its yaml file. bamboo Convert a Bamboo pipeline to GitHub Actions workflows and output its yaml file. circle-ci Convert a CircleCI pipeline to GitHub Actions workflows and output the yaml file(s). gitlab Convert a GitLab pipeline to a GitHub Actions workflow and output the yaml file. jenkins Convert a Jenkins job to a GitHub Actions workflow and output its yaml file. travis-ci Convert a Travis CI pipeline to a GitHub Actions workflow and output its yaml file.
Migrating a pipeline to GitHub Actions
$ gh actions-importer migrate -h Description: Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes. [...] Commands: azure-devops Convert an Azure DevOps pipeline to a GitHub Actions workflow and open a pull request with the changes. bamboo Convert a Bamboo pipeline to GitHub Actions workflows and open a pull request with the changes. circle-ci Convert a CircleCI pipeline to GitHub Actions workflows and open a pull request with the changes. gitlab Convert a GitLab pipeline to a GitHub Actions workflow and open a pull request with the changes. jenkins Convert a Jenkins job to a GitHub Actions workflow and open a pull request with the changes. travis-ci Convert a Travis CI pipeline to a GitHub Actions workflow and open a pull request with the changes.
Performing self-serve migrations using IssueOps
Using the GitHub Actions Importer labs repository
Legal notice
MIT License Copyright (c) 2022 GitHub Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.