Rebrand labs
This commit is contained in:
Ethan Dennis
+48
-46
@@ -3,9 +3,10 @@
|
||||
In this lab, you will use the `audit` command to get a high-level view of all pipelines in a GitLab server.
|
||||
|
||||
The `audit` command will perform the following steps:
|
||||
|
||||
1. Fetch all of the projects defined in a GitLab group.
|
||||
2. Convert each pipeline to their equivalent GitHub Actions workflow.
|
||||
3. Generate a report that summarizes how complete and complex of a migration is possible with Valet.
|
||||
3. Generate a report that summarizes how complete and complex of a migration is possible with GitHub Actions Importer.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -17,10 +18,10 @@ The `audit` command will perform the following steps:
|
||||
You will be performing an audit against your preconfigured GitLab server. Answer the following questions before running this command:
|
||||
|
||||
1. What namespace (e.g. group) do you want to audit?
|
||||
- __valet__. In this example you will be auditing the `valet` group. In the future, you could add additional groups and subgroups to the audit command.
|
||||
- __actions-importer__. In this example you will be auditing the `actions-importer` group. In the future, you could add additional groups and subgroups to the audit command.
|
||||
|
||||
2. Where do you want to store the result?
|
||||
- __tmp/audit__. This can be any path within the working directory from which Valet commands are executed.
|
||||
- __tmp/audit__. This can be any path within the working directory from which GitHub Actions Importer commands are executed.
|
||||
|
||||
### Steps
|
||||
|
||||
@@ -28,7 +29,7 @@ You will be performing an audit against your preconfigured GitLab server. Answer
|
||||
2. Run the following command from the root directory:
|
||||
|
||||
```bash
|
||||
gh actions-importer audit gitlab --output-dir tmp/audit --namespace valet
|
||||
gh actions-importer audit gitlab --output-dir tmp/audit --namespace actions-importer
|
||||
```
|
||||
|
||||
3. The command will list all the files written to disk in green when the command succeeds.
|
||||
@@ -43,7 +44,7 @@ You will be performing an audit against your preconfigured GitLab server. Answer
|
||||
|
||||
#### Pipelines
|
||||
|
||||
The pipeline summary section contains high level statistics regarding the conversion rate done by Valet:
|
||||
The pipeline summary section contains high level statistics regarding the conversion rate done by GitHub Actions Importer:
|
||||
|
||||
```md
|
||||
## Pipelines
|
||||
@@ -70,17 +71,17 @@ Here are some key terms in the “Pipelines” section in the above example:
|
||||
|
||||
- __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.
|
||||
- __Unsupported__ pipelines are definition types that are not supported by Valet. Auto DevOps pipelines are not supported.
|
||||
- __Unsupported__ pipelines are definition types that are not supported by GitHub Actions Importer. Auto DevOps pipelines are not supported.
|
||||
- __Failed__ pipelines encountered a fatal error when being converted. This can occur for one of three reasons:
|
||||
- The pipeline was misconfigured and not valid in GitLab.
|
||||
- Valet encountered an internal error when converting it.
|
||||
- GitHub Actions Importer encountered an internal error when converting it.
|
||||
- There was an unsuccessful network response, often due to invalid credentials, that caused the pipeline to be inaccessible.
|
||||
|
||||
The "Job types" section will summarize which types of pipelines are being used and which are supported or unsupported by Valet.
|
||||
The "Job types" section will summarize which types of pipelines are being used and which are supported or unsupported by GitHub Actions Importer.
|
||||
|
||||
#### Build steps
|
||||
|
||||
The build steps summary section presents an overview of the individual build steps that are used across all pipelines and how many were automatically converted by Valet.
|
||||
The build steps summary section presents an overview of the individual build steps that are used across all pipelines and how many were automatically converted by GitHub Actions Importer.
|
||||
|
||||
```md
|
||||
### Build steps
|
||||
@@ -129,7 +130,7 @@ There is an equivalent breakdown of build triggers, environment variables, and o
|
||||
|
||||
#### Manual Tasks
|
||||
|
||||
The manual tasks summary section presents an overview of the manual tasks that you will need to perform that Valet is not able to complete automatically.
|
||||
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.
|
||||
|
||||
```md
|
||||
### Manual tasks
|
||||
@@ -153,25 +154,25 @@ The final section of the audit report provides a manifest of all of the files th
|
||||
```md
|
||||
### Successful
|
||||
|
||||
#### valet/included-files-example
|
||||
#### actions-importer/included-files-example
|
||||
|
||||
- [valet/included-files-example/.github/workflows/included-files-example.yml](valet/included-files-example/.github/workflows/included-files-example.yml)
|
||||
- [valet/included-files-example/config.json](valet/included-files-example/config.json)
|
||||
- [valet/included-files-example/source.yml](valet/included-files-example/source.yml)
|
||||
- [actions-importer/included-files-example/.github/workflows/included-files-example.yml](actions-importer/included-files-example/.github/workflows/included-files-example.yml)
|
||||
- [actions-importer/included-files-example/config.json](actions-importer/included-files-example/config.json)
|
||||
- [actions-importer/included-files-example/source.yml](actions-importer/included-files-example/source.yml)
|
||||
|
||||
#### valet/terraform-example
|
||||
#### actions-importer/terraform-example
|
||||
|
||||
- [valet/terraform-example/.github/workflows/terraform-example.yml](valet/terraform-example/.github/workflows/terraform-example.yml)
|
||||
- [valet/terraform-example/config.json](valet/terraform-example/config.json)
|
||||
- [valet/terraform-example/source.yml](valet/terraform-example/source.yml)
|
||||
- [actions-importer/terraform-example/.github/workflows/terraform-example.yml](actions-importer/terraform-example/.github/workflows/terraform-example.yml)
|
||||
- [actions-importer/terraform-example/config.json](actions-importer/terraform-example/config.json)
|
||||
- [actions-importer/terraform-example/source.yml](actions-importer/terraform-example/source.yml)
|
||||
|
||||
#### valet/child-parent-example
|
||||
#### actions-importer/child-parent-example
|
||||
|
||||
- [valet/child-parent-example/.github/workflows/child-parent-example.yml](valet/child-parent-example/.github/workflows/child-parent-example.yml)
|
||||
- [valet/child-parent-example/.github/workflows/a-.gitlab-ci.yml](valet/child-parent-example/.github/workflows/a-.gitlab-ci.yml)
|
||||
- [valet/child-parent-example/.github/workflows/b-.gitlab-ci.yml](valet/child-parent-example/.github/workflows/b-.gitlab-ci.yml)
|
||||
- [valet/child-parent-example/config.json](valet/child-parent-example/config.json)
|
||||
- [valet/child-parent-example/source.yml](valet/child-parent-example/source.yml)
|
||||
- [actions-importer/child-parent-example/.github/workflows/child-parent-example.yml](actions-importer/child-parent-example/.github/workflows/child-parent-example.yml)
|
||||
- [actions-importer/child-parent-example/.github/workflows/a-.gitlab-ci.yml](actions-importer/child-parent-example/.github/workflows/a-.gitlab-ci.yml)
|
||||
- [actions-importer/child-parent-example/.github/workflows/b-.gitlab-ci.yml](actions-importer/child-parent-example/.github/workflows/b-.gitlab-ci.yml)
|
||||
- [actions-importer/child-parent-example/config.json](actions-importer/child-parent-example/config.json)
|
||||
- [actions-importer/child-parent-example/source.yml](actions-importer/child-parent-example/source.yml)
|
||||
```
|
||||
|
||||
Each pipeline will have a variety of files written that include:
|
||||
@@ -188,35 +189,36 @@ Each pipeline will have a variety of files written that include:
|
||||
|
||||
```csv
|
||||
Pipeline,Action,File path
|
||||
valet/included-files-example,actions/checkout@v2,tmp/audit/valet/included-files-example/.github/workflows/included-files-example.yml
|
||||
valet/terraform-example,actions/checkout@v2,tmp/audit/valet/terraform-example/.github/workflows/terraform-example.yml
|
||||
valet/child-parent-example,actions/checkout@v2,tmp/audit/valet/child-parent-example/.github/workflows/child-parent-example.yml
|
||||
valet/child-parent-example,./.github/workflows/a-.gitlab-ci.yml,tmp/audit/valet/child-parent-example/.github/workflows/child-parent-example.yml
|
||||
valet/child-parent-example,./.github/workflows/b-.gitlab-ci.yml,tmp/audit/valet/child-parent-example/.github/workflows/child-parent-example.yml
|
||||
valet/include-file-example,actions/checkout@v2,tmp/audit/valet/include-file-example/.github/workflows/include-file-example.yml
|
||||
valet/basic-pipeline-example,actions/checkout@v2,tmp/audit/valet/basic-pipeline-example/.github/workflows/basic-pipeline-example.yml
|
||||
valet/gatsby-example,actions/checkout@v2,tmp/audit/valet/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
valet/gatsby-example,actions/cache@v2,tmp/audit/valet/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
valet/gatsby-example,actions/upload-artifact@v2,tmp/audit/valet/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
valet/gatsby-example,actions/download-artifact@v2,tmp/audit/valet/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
valet/gatsby-example,JamesIves/[email protected],tmp/audit/valet/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
valet/android-example,actions/checkout@v2,tmp/audit/valet/android-example/.github/workflows/android-example.yml
|
||||
valet/android-example,actions/upload-artifact@v2,tmp/audit/valet/android-example/.github/workflows/android-example.yml
|
||||
valet/android-example,actions/download-artifact@v2,tmp/audit/valet/android-example/.github/workflows/android-example.yml
|
||||
valet/dotnet-example,actions/checkout@v2,/data/tmp/audit/valet/dotnet-example/.github/workflows/dotnet-example.yml
|
||||
valet/dotnet-example,actions/upload-artifact@v2,tmp/audit/valet/dotnet-example/.github/workflows/dotnet-example.yml
|
||||
valet/dotnet-example,actions/download-artifact@v2,tmp/audit/valet/dotnet-example/.github/workflows/dotnet-example.yml
|
||||
valet/node-example,actions/checkout@v2,tmp/audit/valet/node-example/.github/workflows/node-example.yml
|
||||
valet/node-example,actions/cache@v2,tmp/audit/valet/node-example/.github/workflows/node-example.yml
|
||||
valet/rails-example,actions/checkout@v2,tmp/audit/valet/rails-example/.github/workflows/rails-example.yml
|
||||
actions-importer/included-files-example,actions/checkout@v2,tmp/audit/actions-importer/included-files-example/.github/workflows/included-files-example.yml
|
||||
actions-importer/terraform-example,actions/checkout@v2,tmp/audit/actions-importer/terraform-example/.github/workflows/terraform-example.yml
|
||||
actions-importer/child-parent-example,actions/checkout@v2,tmp/audit/actions-importer/child-parent-example/.github/workflows/child-parent-example.yml
|
||||
actions-importer/child-parent-example,./.github/workflows/a-.gitlab-ci.yml,tmp/audit/actions-importer/child-parent-example/.github/workflows/child-parent-example.yml
|
||||
actions-importer/child-parent-example,./.github/workflows/b-.gitlab-ci.yml,tmp/audit/actions-importer/child-parent-example/.github/workflows/child-parent-example.yml
|
||||
actions-importer/include-file-example,actions/checkout@v2,tmp/audit/actions-importer/include-file-example/.github/workflows/include-file-example.yml
|
||||
actions-importer/basic-pipeline-example,actions/checkout@v2,tmp/audit/actions-importer/basic-pipeline-example/.github/workflows/basic-pipeline-example.yml
|
||||
actions-importer/gatsby-example,actions/checkout@v2,tmp/audit/actions-importer/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
actions-importer/gatsby-example,actions/cache@v2,tmp/audit/actions-importer/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
actions-importer/gatsby-example,actions/upload-artifact@v2,tmp/audit/actions-importer/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
actions-importer/gatsby-example,actions/download-artifact@v2,tmp/audit/actions-importer/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
actions-importer/gatsby-example,JamesIves/[email protected],tmp/audit/actions-importer/gatsby-example/.github/workflows/gatsby-example.yml
|
||||
actions-importer/android-example,actions/checkout@v2,tmp/audit/actions-importer/android-example/.github/workflows/android-example.yml
|
||||
actions-importer/android-example,actions/upload-artifact@v2,tmp/audit/actions-importer/android-example/.github/workflows/android-example.yml
|
||||
actions-importer/android-example,actions/download-artifact@v2,tmp/audit/actions-importer/android-example/.github/workflows/android-example.yml
|
||||
actions-importer/dotnet-example,actions/checkout@v2,/data/tmp/audit/actions-importer/dotnet-example/.github/workflows/dotnet-example.yml
|
||||
actions-importer/dotnet-example,actions/upload-artifact@v2,tmp/audit/actions-importer/dotnet-example/.github/workflows/dotnet-example.yml
|
||||
actions-importer/dotnet-example,actions/download-artifact@v2,tmp/audit/actions-importer/dotnet-example/.github/workflows/dotnet-example.yml
|
||||
actions-importer/node-example,actions/checkout@v2,tmp/audit/actions-importer/node-example/.github/workflows/node-example.yml
|
||||
actions-importer/node-example,actions/cache@v2,tmp/audit/actions-importer/node-example/.github/workflows/node-example.yml
|
||||
actions-importer/rails-example,actions/checkout@v2,tmp/audit/actions-importer/rails-example/.github/workflows/rails-example.yml
|
||||
|
||||
Pipeline,Secret,File path
|
||||
valet/rails-example,${{ secrets.PASSWORD }},tmp/audit/valet/rails-example/.github/workflows/rails-example.yml
|
||||
actions-importer/rails-example,${{ secrets.PASSWORD }},tmp/audit/actions-importer/rails-example/.github/workflows/rails-example.yml
|
||||
|
||||
Pipeline,Runner,File path
|
||||
```
|
||||
|
||||
The contents of this file can be useful in answering questions similar to the following:
|
||||
|
||||
- What workflows will depend on which actions?
|
||||
- What workflows use an action that must go through a security review?
|
||||
- What workflows use specific secrets?
|
||||
|
||||
Reference in New Issue
Block a user