j-dunham
59 lines
4.0 KiB
Markdown
59 lines
4.0 KiB
Markdown
# Perform a production migration of a GitLab pipeline
|
|
In this lab, we will use the Valet `migrate` command to migrate a GitLab pipeline to GitHub Actions.
|
|
The previous commands used in the labs, such as `audit` and `dry-run` have prepared us to run a migration.
|
|
The `migrate` command will transform the Gitlab pipeline into a GitHub Actions workflow like the `dry-run` command did, but instead of writing these files locally, it will open a pull request with the files.
|
|
The pull request will 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)
|
|
- [Preparing for migration](#preparing-for-migration)
|
|
- [Performing the migration](#performing-a-migration)
|
|
- [Reviewing the pull request](#reviewing-the-pull-request)
|
|
- [Next Lab](#next-lab)
|
|
|
|
## Prerequisites
|
|
|
|
1. Followed [steps](../gitlab#readme) to set up your codespace environment.
|
|
2. Completed the [configure lab](../gitlab/valet-configure-lab.md)
|
|
3. Completed the [dry-run lab](../gitlab/valet-dry-run-lab.md)
|
|
4. Completed the [dry-run lab with custom transformer](../gitlab/valet-custom-transformers-lab.md)
|
|
|
|
## Preparing for migration
|
|
|
|
Before running the command we need to collect some information:
|
|
1. What is the project we want to migrate? __rails-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 logs? __./tmp/migrate__.
|
|
4. What is the URL for the GitHub repository we want to add the workflow too? __this repo!__. *When constructing the value for the migrate command it should match this url https://github.com/GITHUB-ORG-USERNAME-HERE/GITHUB-REPO-NAME-HERE with `GITHUB-ORG-USERNAME` and `GITHUB-REPO-NAME` substitued with your values*
|
|
|
|
## Performing a migration
|
|
|
|
1. Run `migrate` command using the information collected above, make sure to update the `--target-url` value with the information from step 4.
|
|
|
|
```
|
|
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 in the target GitHub repository.
|
|
|
|
4. Open the pull request by clicking the green pull request link in the output of the migrate command, if you have trouble clicking it you can always copy and paste the url in your browser.
|
|
|
|
|
|
|
|
## Reviewing the pull request
|
|
|
|
1. Lets first look at the `Conversation` tab of the PR. It tells us we have a manual task to perform before the GitHub Actions workflow is functional. We need to add 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.
|
|
|
|
2. Review the workflow we are adding by clicking on `Files changed` tab. This is where you would double check everything looks good. If it didn't you could push commits with the required changes, prior to merging.
|
|
|
|
3. Go back to the `Conversation` tab and click `Merge pull request`
|
|
|
|
4. Once the PR is merged the new workflow should start and we can view it by clicking `Actions` in the top navigation bar
|
|
|
|
<img width="1119" alt="actions-screen-shot" src="https://user-images.githubusercontent.com/18723510/184960870-590b1a28-422f-4350-9ec0-0423bf7ad445.png">
|
|
|
|
5. The migration is complete and we have successfully transformed a pipeline from GitLab into a GitHub Actions workflow, added it to a GitHub Repository, and run the workflow in Actions.
|
|
|
|
### Next Lab
|
|
|
|
This concludes the Valet labs for GitLab, if you are interested exploring the power of Valet more. You can leverage the demo GitLab Instance and modify and add new projects that more closely match your needs and try out the commands again!
|