add readme for circleCI setup

2022-09-07 09:36:46 -04:00
parent 8071dc9d63
commit 5f6ce0003e
1 changed files with 75 additions and 0 deletions
@@ -0,0 +1,75 @@
+# CircleCI 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 CircleCI pipelines to GitHub Actions.
+
+These steps **must** be completed prior to starting other labs.
+
+## 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.
+
+## Configure your Codespace
+
+1. Start a new Codespace.
+
+- Click the `Code` with button down arrow above 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. The version information may differ than what is shown below, it is expected that the `valet-cli` version is unknown. This will be corrected in the [configure credentials for Valet](1-configure.md) lab.
+
+  ```bash
+  gh version 2.14.3 (2022-07-26)
+  gh valet        github/gh-valet v0.1.12
+  valet-cli       unknown
+  ```
+
+  - If `gh valet version` did not produce similar output then please follow the troubleshooting [guide](#troubleshoot-the-valet-cli).
+
+
+
+## Labs for CircleCI
+
+Perform the following labs to test-drive Valet
+
+1. [Configure credentials for Valet](1-configure.md)
+2. [Perform an audit of CircleCI](2-audit.md)
+3. [Perform a dry-run of a CircleCI pipeline](3-dry-run.md)
+4. [Use custom transformers to customize Valet's behavior](4-custom-transformers.md)
+5. [Perform a production migration of a CircleCI pipeline](5-migrate.md)
+6. [Forecast potential build runner usage](6-forecast.md)
+
+## Troubleshoot the Valet CLI
+
+The CLI extension for Valet can be manually installed by following these steps:
+
+- Verify you are in the codespace terminal
+- Run this command from within the codespace's terminal:
+
+  ```bash
+  gh extension install github/gh-valet
+  ```
+
+- Verify the result of the install contains:
+
+  ```bash
+  ✓ Installed extension github/gh-valet
+  ```
+
+- If you get an error similar to the image below, then click the link in the terminal output to authorize the token.
+  - Restart the codespace after clicking the link.
+  ![img](https://user-images.githubusercontent.com/26442605/169588015-9414404f-82b6-4d0f-89d4-5f0e6941b029.png)
+- Verify Valet CLI extension is installed and working by running the following command from the codespace's terminal:
+
+  ```bash
+  gh valet version
+  ```