diff --git a/azure_devops/1-configure.md b/azure_devops/1-configure.md index 1e9f34a..87ba8a9 100644 --- a/azure_devops/1-configure.md +++ b/azure_devops/1-configure.md @@ -66,7 +66,7 @@ You will need to complete all of the setup instructions [here](./readme.md#confi ## Verify your environment -To verify our environment is configured correctly, run the `update` CLI command. The `update` CLI command will download the latest version of GitHub Actions Importer to your codespace. +To verify your environment is configured correctly, run the `update` CLI command. The `update` CLI command will download the latest version of GitHub Actions Importer to your codespace. 1. In the codespace terminal, run the following command: diff --git a/azure_devops/2-audit.md b/azure_devops/2-audit.md index c2fc303..34d9d68 100644 --- a/azure_devops/2-audit.md +++ b/azure_devops/2-audit.md @@ -69,7 +69,7 @@ Supported: **5 (100%)** - YAML: **3** ``` -Here are some key terms in the "Pipelines" section in the above example: +Here are some key terms in the "Pipelines" section: - __Successful__ pipelines had 100% of the pipeline constructs and individual items converted automatically to their GitHub Actions equivalent. - __Partially successful__ pipelines had all of the pipeline constructs converted, however, there were some individual items (e.g. build tasks or build triggers) that were not converted automatically to their GitHub Actions equivalent. @@ -111,7 +111,7 @@ Actions: **19** - actions/setup-node@v2: **1** ``` -Here are some key terms in the "Build steps" section in the above example: +Here are some key terms in the "Build steps" section: - A __known__ build step is a step that was automatically converted to an equivalent action. - An __unknown__ build step is a step that was not automatically converted to an equivalent action. @@ -138,7 +138,7 @@ Self hosted runners: **1** - `mechamachine`: **1** ``` -Here are some key terms in the "Manual tasks" section in the above example: +Here are some key terms in the "Manual tasks" section: - A __secret__ refers to a repository or organization level secret that is used by the converted pipelines. These secrets will need to be created manually in Actions in order for these pipelines to function properly. - A __self-hosted runner__ refers to a label of a runner that is referenced by a converted pipeline that is not a GitHub-hosted runner. You will need to manually define these runners in order for these pipelines to function properly. @@ -176,7 +176,7 @@ Each pipeline will have a variety of files written that include: - The converted workflow. - Stack traces that can used to troubleshoot a failed pipeline conversion -## Inspect the workflow usage csv file +## Inspect the workflow usage .csv file 1. Open the `tmp/audit/workflow_usage.csv` file in the file explorer. 2. This file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline: diff --git a/azure_devops/readme.md b/azure_devops/readme.md index 6de82e5..1bbfb5e 100644 --- a/azure_devops/readme.md +++ b/azure_devops/readme.md @@ -1,6 +1,6 @@ -# Azure Pipelines to Actions migrations powered by GitHub Actions Importer +# Azure Pipelines migrations powered by GitHub Actions Importer -These instructions will guide you through configuring the GitHub Codespaces environment that will be used in these labs to demonstrate how to use GitHub Actions Importer to migrate Azure DevOps pipelines to GitHub Actions. +These instructions will guide you through configuring the GitHub Codespaces environment that you will use in these labs to learn how to use GitHub Actions Importer to migrate Azure DevOps pipelines to GitHub Actions. These steps **must** be completed prior to starting other labs. @@ -34,7 +34,7 @@ These steps **must** be completed prior to starting other labs. actions-importer/cli unknown ``` - - If `gh actions-importer version` did not produce similar output, please refer to the troubleshooting [guide](#troubleshoot-the-actions-importer/cli). + - If `gh actions-importer version` did not produce similar output, please refer to the [troubleshooting section](#troubleshoot-the-github-actions-importer-cli). ## Bootstrap your Azure DevOps organization @@ -45,7 +45,7 @@ These steps **must** be completed prior to starting other labs. - Click `Personal access tokens`. - Select `+ New Token` - Name your token, select the organization where you want to use the token, and set your token to automatically expire after a set number of days. - - Select the following scopes (you may need to `Show all scopes` at the bottom of the page to reveal all scopes): + - Select the following scopes (you may need to select `Show all scopes` at the bottom of the page to reveal all scopes): - Agents Pool: `Read` - Build: `Read & execute` - Code: `Read & write` @@ -101,9 +101,6 @@ The CLI extension for GitHub Actions Importer can be manually installed by follo ✓ Installed extension github/gh-actions-importer ``` -- If you get an error similar to the image below, click the link in the terminal output to authorize the token. - - Restart the codespace after clicking the link. - ![img](https://user-images.githubusercontent.com/26442605/169588015-9414404f-82b6-4d0f-89d4-5f0e6941b029.png) - Verify GitHub Actions Importer CLI extension is installed and working by running the following command from the codespace terminal: ```bash diff --git a/circle_ci/readme.md b/circle_ci/readme.md index 091e7e6..600f190 100644 --- a/circle_ci/readme.md +++ b/circle_ci/readme.md @@ -1,6 +1,6 @@ -# CircleCI to Actions migrations powered by GitHub Actions Importer +# CircleCI migrations powered by GitHub Actions Importer -The instructions below will guide you through configuring a GitHub Codespace environment that will be used in subsequent labs that demonstrate how to use GitHub Actions Importer to migrate CircleCI pipelines to GitHub Actions. +The instructions below will guide you through configuring a GitHub Codespace environment that you will use in subsequent labs to learn how to use GitHub Actions Importer to migrate CircleCI pipelines to GitHub Actions. These steps **must** be completed prior to starting other labs. @@ -12,8 +12,8 @@ These steps **must** be completed prior to starting other labs. 1. Start a new Codespace. - - Click the `Code` with button down arrow above repository on the repository's landing page. - - Click the `Codespaces` tab + - Click the `Code` button on your repository's landing page. + - Click the `Codespaces` tab. - Click `Create codespaces on main` to create the codespace. - After the Codespace has initialized there will be a terminal present. @@ -34,7 +34,7 @@ These steps **must** be completed prior to starting other labs. actions-importer/cli unknown ``` - - If `gh actions-importer version` did not produce similar output, refer to the troubleshooting [guide](#troubleshoot-the-actions-importer/cli). + - If `gh actions-importer version` did not produce similar output, refer to the [troubleshooting section](#troubleshoot-the-github-actions-importer-cli). ## Labs for CircleCI @@ -65,9 +65,6 @@ The CLI extension for GitHub Actions Importer can be manually installed by follo ✓ Installed extension github/gh-actions-importer ``` -- If you get an error similar to the image below, then click the link in the terminal output to authorize the token. - - Restart the codespace after clicking the link. - ![img](https://user-images.githubusercontent.com/26442605/169588015-9414404f-82b6-4d0f-89d4-5f0e6941b029.png) - Verify GitHub Actions Importer CLI extension is installed and working by running the following command from the codespace's terminal: ```bash diff --git a/readme.md b/readme.md index df36a2f..6cc1da8 100644 --- a/readme.md +++ b/readme.md @@ -1,16 +1,17 @@ -# GitHub Actions Importer learning labs +# GitHub Actions Importer labs [GitHub Actions Importer](https://docs.github.com/en/actions/migrating-to-github-actions/automating-migration-with-github-actions-importer) helps plan, forecast, and automate the migration of Azure DevOps, CircleCI, GitLab, Jenkins, and Travis CI pipelines to GitHub Actions. This repository contains learning paths that teach you how to use GitHub Actions Importer and how to approach migrations to Actions. > **Note**: GitHub Actions Importer is currently available as a public preview. Visit the [sign up page](https://github.com/features/actions-importer/signup) to request access to the preview. +## Choose your learning path To get started: 1. Use the `actions/importer-labs` repository as a template to [generate](https://github.com/actions/importer-labs/generate) a new GitHub repository. -2. Select which learning path to begin with. There are currently learning paths for: - - [Migrations from Azure DevOps to GitHub Actions](/azure_devops/readme.md) - - [Migrations from CircleCI to GitHub Actions](/circle_ci/readme.md) - - [Migrations from GitLab to GitHub Actions](/gitlab/readme.md) - - [Migrations from Jenkins to GitHub Actions](/jenkins/readme.md) - - [Migrations from Travis CI to GitHub Actions](/travis/readme.md) +2. Choose where to start. There are currently learning paths for: + - [Migrating from Azure DevOps to GitHub Actions](/azure_devops/readme.md) + - [Migrating from CircleCI to GitHub Actions](/circle_ci/readme.md) + - [Migrating from GitLab to GitHub Actions](/gitlab/readme.md) + - [Migrating from Jenkins to GitHub Actions](/jenkins/readme.md) + - [Migrating from Travis CI to GitHub Actions](/travis/readme.md) 3. Each learning path describes how to configure your codespace, bootstrap a CI/CD environment, and troubleshoot GitHub Actions Importer.