diff --git a/gitlab/3-dry-run.md b/gitlab/3-dry-run.md index ac0d8f6..a30dd1d 100644 --- a/gitlab/3-dry-run.md +++ b/gitlab/3-dry-run.md @@ -1,4 +1,4 @@ -# Dry run the migration of an GitLab pipeline to GitHub Actions +# Perform a Dry-run of a GitLab pipeline In this lab, you will use the Valet `dry-run` command to convert a GitLab pipeline to its equivalent GitHub Actions workflow. The end result of this command will be the actions workflow written to your local filesystem. @@ -15,24 +15,31 @@ The end result of this command will be the actions workflow written to your loca ## Perform a dry run -We will be performing a dry-run against a preconfigured project in the GitLab instance. Before running the command we need to collect some information: - 1. What is the project we want to convert? __basic-pipeline-example__ - 2. What is the namespace for that project? __Valet. In this case the namespace is the same as the group the project is in__ - 3. Where do we want to store the result? __./tmp/dry-run-lab. This can be any valid path on the system. In the case of codespaces it is generally best to use `./tmp/SOME_DIRECTORY_HERE` so the files show in explorer__ -### Steps -1. Navigate to the codespace terminal -2. Run the dry-run command using the values determined above +1) Collect information to construct the `dry-run` command: +- What is the project we want to convert? + - basic-pipeline-example +- What is the namespace for that project? + - Valet. In this case the namespace is the same as the group the project is in. +- Where do we want to store the result? + - ./tmp/dry-run-lab. This can be any valid path on the system. In the case of codespaces it is generally best to use `./tmp/SOME_DIRECTORY_HERE` so the files show in explorer. + +2. Run the dry-run command in the terminal using the values from step 1. + ``` gh valet dry-run gitlab --output-dir ./tmp/dry-run-lab --namespace valet --project basic-pipeline-example ``` -3. When the command finishes the output files should be printed to the terminal. - dry-run-terminal -4. Open generated actions workflow - - Find `./tmp/dry-run-lab/valet` in the file explorer pane in codespaces. - - Click `basic-pipeline-example.yml` to open - dry-run-explorer +3. Verify the command printed the result files to the terminal. + + dry-run-terminal + +4. Open generated actions workflow + + - Find `./tmp/dry-run-lab/valet` in the file explorer pane in codespaces. + - Click `basic-pipeline-example.yml` to open. + + dry-run-explorer ## Review dry-run output The dry-run output will show you the GitHub Actions yaml that would be migrated to GitHub with the `migrate` command. We will now take a quick look at what was generated.