edits to audit lab

This commit is contained in:
Jennifer Kerns
2022-11-07 09:28:21 -08:00
committed by GitHub
parent 6f3c122e01
commit 5421a25f8d
+7 -7
View File
@@ -5,7 +5,7 @@ In this lab, you will use the `audit` command to get a high-level view of all pi
The `audit` command will perform the following steps:
1. Fetch all of the projects defined in a Jenkins server.
2. Convert each pipeline to their equivalent GitHub Actions workflow.
2. Convert each pipeline to its equivalent GitHub Actions workflow.
3. Generate a report that summarizes how complete and complex of a migration is possible with GitHub Actions Importer.
## Prerequisites
@@ -65,7 +65,7 @@ The audit summary, logs, config files, jenkinsfiles, and transformed workflows w
1. Find the `audit_summary.md` file in the file explorer.
2. Right-click the `audit_summary.md` file and select `Open Preview`.
3. This file contains details that summarizes what percentage of your pipelines were converted automatically.
3. This file contains details that summarize what percentage of your pipelines were converted automatically.
### Review the audit summary
@@ -96,7 +96,7 @@ Unsupported: **1 (14%)**
- scripted: **1**
```
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.
@@ -145,7 +145,7 @@ Actions: **22**
- actions/upload-artifact@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.
@@ -158,7 +158,7 @@ Here are some key terms in the "Build steps" section in the above example:
There is an equivalent breakdown of build triggers, environment variables, and other uncategorized items displayed in the audit summary file.
#### Manual Tasks
#### Manual tasks
The manual tasks summary section presents an overview of the manual tasks that you will need to perform that GitHub Actions Importer is not able to complete automatically.
@@ -178,7 +178,7 @@ Self hosted runners: **7**
- `DemoRunner`: **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.
@@ -239,7 +239,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: