actions/importer-labs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update valet-migrate-lab.md

Browse Source
This commit is contained in:
j-dunham
2022-08-16 15:05:30 -04:00
committed by GitHub
parent 61319d5371
commit c14bef3c4a
1 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
gitlab/valet-migrate-lab.md
+21 -15
View File
@@ -1,13 +1,13 @@
# Migrate an Azure DevOps pipeline to GitHub Actions # Migrate an Azure DevOps pipeline to GitHub Actions
In this lab, you will use the Valet `migrate` command to migrate a GitLab pipeline to GitHub Actions. In this lab, we will use the Valet `migrate` command to migrate a GitLab pipeline to GitHub Actions.
All of the previous commands we have been using, such as `audit` and `dry-run` have be preparing us to run the `migrate` command. All of the previous commands we have been using, such as `audit` and `dry-run` have been preparing us to run the `migrate` command.
The `migrate` command is what will generate the GitHub Actions workflow files like the `dry-run` and then create a pull request with the files. The `migrate` command is what will generate the GitHub Actions workflow files, like the `dry-run`, and create a pull request with the files.
The pull request will also contain `Manual Tasks` if required. These task are manual steps that Valet could not do on your behalf, like creating a runner or adding a secret. The pull request will also contain a checklist of `Manual Tasks` if required. These tasks are changes that Valet could not do on our behalf, like creating a runner or adding a secret to a repository.
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Preparing for migration](#preparing-for-migration) - [Preparing for migration](#preparing-for-migration)
- [Perform a migration](#perform-a-migration) - [Performing the migration](#performing-a-migration)
- [View the pull request](#view-the-pull-request) - [Reviewing the pull request](#reviewing-the-pull-request)
- [Next Lab](#next-lab) - [Next Lab](#next-lab)
## Prerequisites ## Prerequisites
@@ -18,19 +18,25 @@ The pull request will also contain `Manual Tasks` if required. These task are ma
Before running the command we need to collect some information: Before running the command we need to collect some information:
1. What is the project we want to migrate? TBD 1. What is the project we want to migrate? TBD
2. What is the namespace for that project? __Valet. In this case the namespace is the same as the group the project is in__ 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. What is the GitHub Repository we want to add the workflow too? TBD 3. Where do we want to store the logs? __./tmp/migrate__.
4. What is the URL for GitHub Repository we want to add the workflow too? __We can use this repo__. *When constructing the value for the migrate command it should match the the url https://github.com/GITHUB-ORG-USERNAME-HERE/GITHUB-REPO-NAME-HERE with `GITHUB-ORG-USERNAME` and `GITHUB-REPO-NAME` substitued with your values*
## Perform a migration ## Performing a migration
1. Run `migrate` command using the information collected above 1. Run `migrate` command using the information collected above, make sure to update the `--target-url` value with the information from step 4 above
``` ```
gh valet migrate gitlab --target-url https://github.com/GITHUB-ORG/GITHUB-REPO --output-dir migrate --namespace valet --project TBD gh valet migrate gitlab --target-url https://github.com/GITHUB-ORG-USERNAME-HERE/GITHUB-REPO-NAME-HERE --output-dir ./tmp/migrate --namespace valet --project rails-example
``` ```
2. Valet will create a pull request directly to your GitHub repository. 2. Valet will create a pull request directly in the target GitHub repository.
3. Open the pull request by clicking the green pull request link in the output of the migrate command. See below. 3. Open the pull request by clicking the green pull request link in the output of the migrate command. See below.
ADD_SCREENSHOT_HERE ![pr-screen-shot](https://user-images.githubusercontent.com/18723510/184953133-9bafd9a1-c3f0-40b3-8414-f23cea698c8e.png)
## Review the pull request ## Reviewing the pull request
TBD - Lets first look at the `Conversation` tab of the PR. Its telling us we have a manual task to perform before the GitHub Actions workflow is functional. We need to a secret. We can use the GitHub [documentation](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) for secrets and add a `actions` secret for `PASSWORD` with any value.
- Next, lets review the workflow we are adding by clicking on `Files changed` tab. This is where you would double check everything looks good.
- Now we want to go back to the `Conversation` tab and click `Merge pull request`
- Once the PR is merged the new workflow should start and we can view this by clicking `Actions` in the top navigation
<img width="1119" alt="actions-screen-shot" src="https://user-images.githubusercontent.com/18723510/184960870-590b1a28-422f-4350-9ec0-0423bf7ad445.png">
### Next Lab ### Next Lab
TBD [Forecast GitLab Usage](../gitlab/valet-forecast-lab.md)