Merge branch 'main' into JenniferKerns-patch-7

This commit is contained in:
Ethan Dennis
2022-11-06 17:59:49 -08:00
committed by GitHub
6 changed files with 24 additions and 29 deletions
+1 -1
View File
@@ -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:
+4 -4
View File
@@ -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:
+2 -2
View File
@@ -112,7 +112,7 @@ end
The `transform` method can use any valid ruby syntax and should return a `Hash` that represents the YAML that should be generated for a given step. GitHub Actions Importer will use this method to convert a step with the provided identifier and will use the `item` parameter for the original values configured in Azure DevOps.
Now, we can perform a `dry-run` command with the `--custom-transformers` CLI option. The output of the `dry-run` command should look similar to this:
Now, you can perform a `dry-run` command with the `--custom-transformers` CLI option. The output of the `dry-run` command should look similar to this:
```console
$ gh actions-importer dry-run azure-devops pipeline --pipeline-id 6 --output-dir tmp/dry-run --custom-transformers transformers.rb
@@ -153,7 +153,7 @@ Now you can perform another `dry-run` command and use the `--custom-transformers
gh actions-importer dry-run azure-devops pipeline --pipeline-id :pipeline_id --output-dir tmp/dry-run --custom-transformers transformers.rb
```
Open the workflow that is generated and inspect the contents. Now the `DotnetCoreCLI@2` steps are converted using the customized behavior!
Open the workflow that is generated and inspect the contents. The `DotnetCoreCLI@2` steps are now converted using the customized behavior.
```diff
- - name: Restore
+4 -7
View File
@@ -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