Merge pull request #45 from valet-customers/circleci/configure-lab

CircleCI: Add `configure` lab
2022-09-07 19:53:25 -04:00
parent b51ee599cb e179dc7fc5
commit 9cb6481648
1 changed files with 59 additions and 0 deletions
@@ -0,0 +1,59 @@
+# Configure credentials for Valet
+
+In this lab, you will use the `configure` CLI command to set the required credentials and information for Valet to use when working with CircleCI and GitHub.
+
+You will need to complete all of the setup instructions [here](./readme.md#configure-your-codespace) prior to performing this lab.
+
+## Configuring credentials
+
+1. Create a GitHub Personal Access Token (PAT):
+    - Open github.com in a new browser tab.
+    - Click your profile photo in the top right of the UI and click `Settings`.
+    - Click on `Developer Settings` in the left hand panel.
+    - Click `Personal Access Tokens` and then `Legacy tokens` (if present).
+    - Click `Generate new token` and then `Legacy tokens`. You may be required to authenticate with GitHub during this step.
+    - Select the following scopes: `read:packages` and `workflow`.
+    - Click `Generate token`.
+    - Copy the generated PAT and save in a safe location.
+
+3. Create a CircleCI personal API token using CircleCI's [documentation](https://circleci.com/docs/managing-api-tokens#creating-a-personal-api-token) and store the token in a safe location.
+
+2. Run the `configure` CLI command:
+    - Select the `TERMINAL` tab from within the codespace terminal window.
+    - Run the following command: `gh valet configure`.
+    - Using the down arrow key to highlight `CircleCI`, press the spacebar to select, and then hit enter to continue.
+    - At the prompt enter your GitHub Username and press enter.
+    - At the GitHub Container Registry prompt enter the GitHub PAT generated in step 1 and press enter.
+    - At the GitHub PAT prompt enter the GitHub PAT generated in step 1 and press enter.
+    - At the GitHub url prompt enter the GitHub instance url or hit enter to accept the default value (`https://github.com`).
+    - At the CircleCI token prompt enter the CircleCI access token from step 2 and press enter.
+    - At the CircleCI base url prompt hit enter to accept the default value (`https://circleci.com`).
+    - At the access token to fetch source code in GitHub prompt enter the GitHub PAT generated in step 1 and press enter.
+    - At the GitHub instance url containing source code prompt press enter to accept the default value (`https://github.com`).
+
+    ![configure-screenshot](https://user-images.githubusercontent.com/18723510/188935436-308fa6d3-6eb7-48b9-bbf0-20ab0cdae411.png)
+
+
+## Verify your environment
+
+To verify our environment is configured correctly, we are going to run the `update` CLI command. The `update` CLI command will download the latest version of Valet to your codespace.
+
+1. In the codespace terminal run the following command:
+
+   ```bash
+   gh valet update
+   ```
+
+2. You should see a confirmation that you were logged into the GitHub Container Registry and Valet was updated to the latest version.
+
+   ```bash
+   Login Succeeded
+   latest: Pulling from valet-customers/valet-cli
+   Digest: sha256:a7d00dee8a37e25da59daeed44b1543f476b00fa2c41c47f48deeaf34a215bbb
+   Status: Image is up to date for ghcr.io/valet-customers/valet-cli:latest
+   ghcr.io/valet-customers/valet-cli:latest
+   ```
+
+### Next lab
+
+[Perform an audit of CircleCI](./2-audit.md)