From 9d81e45940eb430b04b03e6eca5407298b0ccf9d Mon Sep 17 00:00:00 2001 From: j-dunham Date: Fri, 2 Sep 2022 10:44:02 -0400 Subject: [PATCH] Update readme.md --- gitlab/readme.md | 65 +++++++++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 29 deletions(-) diff --git a/gitlab/readme.md b/gitlab/readme.md index f3a2fa4..9361318 100644 --- a/gitlab/readme.md +++ b/gitlab/readme.md @@ -1,40 +1,47 @@ -# Valet labs for GitLab +# GitLab to Actions migrations powered by Valet +The instructions below will guide you through configuring a GitHub Codespace environment that will be used in subsequent labs that demonstrate how to use Valet to migrate GitLab pipelines to GitHub Actions. -This lab bootstraps a Valet environment using GitHub Codespaces and enables you to run the Valet CI/CD migration tool against an isolated GitLab instance running in Docker. +These steps **must** be completed prior to starting other labs. -- [Prerequisites](#prerequisites) -- [Setup Codespace for Labs](#setup-codespace-for-labs) -- [Labs for GitLab](#labs-for-gitlab) +## Create your own repository for these labs +1. Ensure that you have created a repository using the [valet-customers/labs](https://github.com/valet-customers/labs) as a template. - -## Prerequisites -1. [Valet Labs](https://github.com/valet-customers/labs) template has been used to generate this repository. - -## Setup Codespace for Labs +## Configure your Codespace 1. Start the codespace - - Click the `Code` button down arrow above the repository on the repository's landing page. - - Click the `Codespaces` tab. - - Click `Create codespaces on main` to create the codespace. If you are in another branch then the `main` branch, the codespace button will have the current branch specified. - - Wait a couple minutes, then verify that the codespace starts up. Once it is fully booted up, the terminal should be present. -2. Verify Valet CLI is installed and working. More information on the [GitHub Valet CLI extension](https://github.com/github/gh-valet) - - Run `gh valet version` in the codespace terminal and verify it returns results like below, actual versions will vary. - ``` - gh version 2.14.3 (2022-07-26) - gh valet github/gh-valet v0.1.12 - valet-cli unknown - ``` - if results do not match try manually installing the valet extension, using the [troubleshooting](#troubleshooting) section. - + +- Click the `Code` button down arrow above the repository on the repository's landing page. +- Click the `Codespaces` tab. +- Click `Create codespaces on main` to create the codespace. +- After the Codespace has initialized there will be a terminal present. + +2. Verify the Valet CLI is installed and working. More information on the Valet extension for the official GitHub CLI can be found [here](https://github.com/github/gh-valet). + +- Run the following command in the codespace's terminal: + +```bash +gh valet version +``` + +- Verify the output is similar to below, if not try manually installing the valet extension, using the [troubleshooting](#troubleshooting) section. + +```bash +gh version 2.14.3 (2022-07-26) +gh valet github/gh-valet v0.1.12 +valet-cli unknown +``` + 3. Run the GitLab setup script. This script will set up GitLab and ensure it is ready to use. In general, this script should be run first if you are starting a new codespace or restarting an existing one. - - from the codespace terminal run `source gitlab/bootstrap/setup.sh`. + +- from the codespace terminal run `source gitlab/bootstrap/setup.sh`. 4. Verify you can login to the GitLab Server. - - Click the `PORTS` tab in the codespace terminal window. - - In the row that starts with `80` mouse over the address under the column heading `Local Address`, and click the globe icon. - - Verify a new browser tab opened to the GitLab login screen. - - Login with the username: `root` and password: `valet-labs!`. - - Verify that you can see the auto populated projects in GitLab, under the `valet` namespace by clicking the `Menu` icon in GitLab, then `Your projects`. + +- Click the `PORTS` tab in the codespace terminal window. +- In the row that starts with `80` mouse over the address under the column heading `Local Address`, and click the globe icon. +- Verify a new browser tab opened to the GitLab login screen. +- Login with the username: `root` and password: `valet-labs!`. +- Verify that you can see the auto populated projects in GitLab, under the `valet` namespace by clicking the `Menu` icon in GitLab, then `Your projects`. ## Labs for GitLab Perform the following labs to test-drive Valet