From a11044361ed349f22c0d686fa59f6de597be5311 Mon Sep 17 00:00:00 2001 From: Ethan Dennis Date: Tue, 20 Sep 2022 12:05:36 -0700 Subject: [PATCH] More img -> text --- azure_devops/1-configure.md | 86 +++++++++++++++++++++---------------- circle_ci/1-configure.md | 54 ++++++++++++++--------- gitlab/1-configure.md | 65 ++++++++++++++++------------ jenkins/1-configure.md | 68 +++++++++++++++++------------ 4 files changed, 160 insertions(+), 113 deletions(-) diff --git a/azure_devops/1-configure.md b/azure_devops/1-configure.md index 0f0fc00..e9e4e57 100644 --- a/azure_devops/1-configure.md +++ b/azure_devops/1-configure.md @@ -7,48 +7,60 @@ You will need to complete all of the setup instructions [here](./readme.md#confi ## Configuring credentials 1. Create an Azure DevOps personal access token (PAT). - - __Note__: you can skip this step if you still have the PAT created during the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). - - Navigate to your existing organization () in your browser. - - In the top right corner of your screen, click `User settings`. - - Click `Personal access tokens`. - - Select `+ New Token` - - Name your token, select the organization where you want to use the token, and set your token to automatically expire after a set number of days. - - Select the following scopes (you may need to `Show more scopes` to reveal all scopes): - - Agents Pool: `Read` - - Build: `Read & Execute` - - Code: `Read & Write` - - Project and Team: `Read, Write, & Manage` - - Release: `Read` - - Service Connections: `Read` - - Task Groups: `Read` - - Variable Groups: `Read` - - Click `Create`. - - Copy the generated API token and save it in a safe location. + __Note__: you can skip this step if you still have the PAT created during the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). + - Navigate to your existing organization () in your browser. + - In the top right corner of your screen, click `User settings`. + - Click `Personal access tokens`. + - Select `+ New Token` + - Name your token, select the organization where you want to use the token, and set your token to automatically expire after a set number of days. + - Select the following scopes (you may need to `Show more scopes` to reveal all scopes): + - Agents Pool: `Read` + - Build: `Read & Execute` + - Code: `Read & Write` + - Project and Team: `Read, Write, & Manage` + - Release: `Read` + - Service Connections: `Read` + - Task Groups: `Read` + - Variable Groups: `Read` + - Click `Create`. + - Copy the generated API token and save it in a safe location. 2. Create a GitHub personal access token (PAT): - - Open github.com in a new browser tab. - - In the top right corner of the UI, click your profile photo and then click `Settings`. - - In the left panel, click `Developer Settings`. - - Click `Personal access tokens` and then `Legacy tokens` (if present). - - Click `Generate new token` and then `Generate new legacy token`. You may be required to authenticate with GitHub during this step. - - Select the following scopes: `workflow` and `read:packages`. - - Click `Generate token`. - - Copy the generated PAT and save it in a safe location. + - Open github.com in a new browser tab. + - In the top right corner of the UI, click your profile photo and then click `Settings`. + - In the left panel, click `Developer Settings`. + - Click `Personal access tokens` and then `Legacy tokens` (if present). + - Click `Generate new token` and then `Generate new legacy token`. You may be required to authenticate with GitHub during this step. + - Select the following scopes: `workflow` and `read:packages`. + - Click `Generate token`. + - Copy the generated PAT and save it in a safe location. 3. Run the `configure` CLI command: - - Select the `TERMINAL` tab from within the codespace terminal. - - Run the following command: `gh valet configure`. - - Use the down arrow key to highlight `Azure DevOps`, press the spacebar to select, and then press enter to continue. - - At the GitHub Container Registry prompt, enter the GitHub PAT generated in step 2 and press enter. - - At the GitHub PAT prompt, enter the GitHub PAT generated in step 2 and press enter. - - At the GitHub URL prompt, enter the GitHub instance URL or press enter to accept the default value (`https://github.com`). - - At the Azure DevOps token prompt, enter the access token from step 1 and press enter. - - At the Azure DevOps URL prompt, enter your Azure DevOps URL or press enter to accept the default value (`https://dev.azure.com`). - - At the prompt, enter your Azure DevOps organization name. This should be the same organization used in the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). - - At the prompt, enter your Azure DevOps project name. This should be the same project name used in the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). + - Select the `TERMINAL` tab from within the codespace terminal. + - Run the following command: `gh valet configure`. + - Use the down arrow key to highlight `Azure DevOps`, press the spacebar to select, and then press enter to continue. + - At the GitHub Container Registry prompt, enter the GitHub PAT generated in step 2 and press enter. + - At the GitHub PAT prompt, enter the GitHub PAT generated in step 2 and press enter. + - At the GitHub URL prompt, enter the GitHub instance URL or press enter to accept the default value (`https://github.com`). + - At the Azure DevOps token prompt, enter the access token from step 1 and press enter. + - At the Azure DevOps URL prompt, enter your Azure DevOps URL or press enter to accept the default value (`https://dev.azure.com`). + - At the prompt, enter your Azure DevOps organization name. This should be the same organization used in the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). + - At the prompt, enter your Azure DevOps project name. This should be the same project name used in the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). - ![img](https://user-images.githubusercontent.com/18723510/187771230-27c97889-d98a-48f7-af01-c1a9f8df6423.png) + ```console + $ gh valet configure + ✔ Which CI providers are you configuring?: Azure DevOps + Enter the following values (leave empty to omit): + ✔ GitHub handle used to authenticate with the GitHub Container Registry: mona + ✔ Personal access token to authenticate with the GitHub Container Registry: *************** + ✔ Personal access token for GitHub: *************** + ✔ Base url of the GitHub instance: https://github.com + ✔ Personal access token for Azure DevOps: *************** + ✔ Base url of the Azure DevOps instance: https://dev.azure.com + ✔ Azure DevOps organization name: :organization + ✔ Azure DevOps project name: :project + Environment variables successfully updated. + ``` ## Verify your environment diff --git a/circle_ci/1-configure.md b/circle_ci/1-configure.md index 5214d16..16c05de 100644 --- a/circle_ci/1-configure.md +++ b/circle_ci/1-configure.md @@ -7,32 +7,44 @@ You will need to complete all of the setup instructions [here](./readme.md#confi ## 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. + - 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 GitHub handle prompt, enter the GitHub username used to generate the GitHub PAT in step 2 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 CircleCI organization name prompt, enter `valet-labs`. This is the organization we'll be using throughout these labs. - - 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`). + - 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 GitHub handle prompt, enter the GitHub username used to generate the GitHub PAT in step 2 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 CircleCI organization name prompt, enter `valet-labs`. This is the organization we'll be using throughout these labs. + - 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) + ```console + $ gh valet configure + ✔ Which CI providers are you configuring?: CircleCI + Enter the following values (leave empty to omit): + ✔ GitHub handle used to authenticate with the GitHub Container Registry: mona + ✔ Personal access token to authenticate with the GitHub Container Registry: *************** + ✔ Personal access token for GitHub: *************** + ✔ Base url of the GitHub instance: https://github.com + ✔ Personal access token for CircleCI: *************** + ✔ Base url of the CircleCI instance: https://circleci.com + ✔ CircleCI organization name: valet-labs + Environment variables successfully updated. + ``` ## Verify your environment diff --git a/gitlab/1-configure.md b/gitlab/1-configure.md index 6a00435..759c950 100644 --- a/gitlab/1-configure.md +++ b/gitlab/1-configure.md @@ -13,40 +13,51 @@ You will need to complete all of the setup instructions [here](./readme.md#confi ``` 2. Open the GitLab server in a new browser tab: - - Click the `PORTS` tab in the codespace terminal window. - - In the `PORTS` tab find the row for port 80. - - Hover over the address under the `Local Address` column and click the globe to "open in browser". + - Click the `PORTS` tab in the codespace terminal window. + - In the `PORTS` tab find the row for port 80. + - Hover over the address under the `Local Address` column and click the globe to "open in browser". 3. Create a GitLab personal access token (PAT): - - Authenticate with the GitLab server using the following credentials: - - Username: `root` - - Password: `valet-labs!` - - Follow the GitLab [instructions](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) to generate a PAT. - - Ensure the token has the `read_api` scope. - - Copy the generated token and save it in a safe location. + - Authenticate with the GitLab server using the following credentials: + - Username: `root` + - Password: `valet-labs!` + - Follow the GitLab [instructions](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) to generate a PAT. + - Ensure the token has the `read_api` scope. + - Copy the generated token and save it in a safe location. 4. Create a GitHub personal access token (PAT): - - Open github.com in a new browser tab. - - In the top right corner of the UI, click your profile photo and click `Settings`. - - In the left panel, click `Developer Settings`. - - Click `Personal access tokens` and then `Legacy tokens` (if present). - - Click `Generate new token` and then `Generate new legacy token`. You may be required to authenticate with GitHub during this step. - - Select the following scopes: `workflow` and `read:packages`. - - Click `Generate token`. - - Copy the generated PAT and save it in a safe location. + - Open github.com in a new browser tab. + - In the top right corner of the UI, click your profile photo and click `Settings`. + - In the left panel, click `Developer Settings`. + - Click `Personal access tokens` and then `Legacy tokens` (if present). + - Click `Generate new token` and then `Generate new legacy token`. You may be required to authenticate with GitHub during this step. + - Select the following scopes: `workflow` and `read:packages`. + - Click `Generate token`. + - Copy the generated PAT and save it in a safe location. 5. Run the `configure` CLI command: - - Select the `TERMINAL` tab from within the codespace terminal window. - - Run the following command: `gh valet configure`. - - Use the down arrow key to highlight `GitLab CI`, press the spacebar to select, and then press 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 4 and press enter. - - At the GitHub PAT prompt, enter the GitHub PAT generated in step 4 and press enter. - - At the GitHub URL prompt, enter the GitHub instance URL or press enter to accept the default value (`https://github.com`). - - At the GitLab CI token prompt, enter the GitLab CI access token from step 3 and press enter. - - At the GitLab CI URL prompt, enter `http://localhost` and press enter. + - Select the `TERMINAL` tab from within the codespace terminal window. + - Run the following command: `gh valet configure`. + - Use the down arrow key to highlight `GitLab CI`, press the spacebar to select, and then press 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 4 and press enter. + - At the GitHub PAT prompt, enter the GitHub PAT generated in step 4 and press enter. + - At the GitHub URL prompt, enter the GitHub instance URL or press enter to accept the default value (`https://github.com`). + - At the GitLab CI token prompt, enter the GitLab CI access token from step 3 and press enter. + - At the GitLab CI URL prompt, enter `http://localhost` and press enter. - ![img](https://user-images.githubusercontent.com/18723510/183990474-d0b2559c-d2bf-40d9-ac43-19af53e45329.png) + ```console + $ gh valet configure + ✔ Which CI providers are you configuring?: GitLab CI + Enter the following values (leave empty to omit): + ✔ GitHub handle used to authenticate with the GitHub Container Registry: mona + ✔ Personal access token to authenticate with the GitHub Container Registry: *************** + ✔ Personal access token for GitHub: *************** + ✔ Base url of the GitHub instance: https://github.com + ✔ Private token for GitLab: *************** + ✔ Base url of the GitLab instance: https://gitlab.com + Environment variables successfully updated. + ``` ## Verify your environment diff --git a/jenkins/1-configure.md b/jenkins/1-configure.md index 8128140..b798761 100644 --- a/jenkins/1-configure.md +++ b/jenkins/1-configure.md @@ -7,40 +7,52 @@ You will need to complete all of the setup instructions [here](./readme.md#confi ## Configuring credentials 1. Open the Jenkins server in a new browser tab: - - Click the `PORTS` tab in the codespace terminal window. - - In the `PORTS` tab, find the row for port 8080. - - Hover over the address under the `Local Address` column and click the globe to "open in browser". + - Click the `PORTS` tab in the codespace terminal window. + - In the `PORTS` tab, find the row for port 8080. + - Hover over the address under the `Local Address` column and click the globe to "open in browser". 2. Create a Jenkins API token: - - In the top right menu bar, click the `admin` button. - - In the left panel, click the `Configure` gear. - - In the `API token` section, click the `Add new Token` button and click `Generate`. - - Copy the generated API token and save it in a safe location. + - In the top right menu bar, click the `admin` button. + - In the left panel, click the `Configure` gear. + - In the `API token` section, click the `Add new Token` button and click `Generate`. + - Copy the generated API token and save it in a safe location. - ![img](https://user-images.githubusercontent.com/19557880/184041667-d06cb7f2-a885-474e-b728-7567314aeaf3.png) + ![img](https://user-images.githubusercontent.com/19557880/184041667-d06cb7f2-a885-474e-b728-7567314aeaf3.png) 3. Create a GitHub personal access token (PAT): - - Open github.com in a new browser tab. - - In the top right corner of the UI, click your profile photo and click `Settings`. - - In the left panel, click `Developer Settings`. - - Click `Personal access tokens` and then `Legacy tokens` (if present). - - Click `Generate new token` and then `Generate new legacy token`. You may be required to authenticate with GitHub during this step. - - Select the following scopes: `workflow` and `read:packages`. - - Click `Generate token`. - - Copy the generated PAT and save it in a safe location. -4. Run the `configure` CLI command: - - Select the `TERMINAL` tab from within the codespace terminal window. - - Run the following command: `gh valet configure`. - - Use the down arrow key to highlight `Jenkins`, press the spacebar to select, and then press 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 3 and press enter. - - At the GitHub PAT prompt, enter the GitHub PAT generated in step 3 and press enter. - - At the GitHub URL prompt, enter the GitHub instance URL or press enter to accept the default value (`https://github.com`). - - At the Jenkins token prompt, enter the Jenkins access token from step 2 and press enter. - - At the Jenkins URL prompt, enter `http://localhost:8080/` and press enter. - - At the Personal access token to fetch source code in GitHub prompt, press enter to accept the default value. + - Open github.com in a new browser tab. + - In the top right corner of the UI, click your profile photo and click `Settings`. + - In the left panel, click `Developer Settings`. + - Click `Personal access tokens` and then `Legacy tokens` (if present). + - Click `Generate new token` and then `Generate new legacy token`. You may be required to authenticate with GitHub during this step. + - Select the following scopes: `workflow` and `read:packages`. + - Click `Generate token`. + - Copy the generated PAT and save it in a safe location. - ![img](https://user-images.githubusercontent.com/19557880/184041328-ce54ea22-b0cd-4c84-b02c-10ad7b09ad89.png) +4. Run the `configure` CLI command: + - Select the `TERMINAL` tab from within the codespace terminal window. + - Run the following command: `gh valet configure`. + - Use the down arrow key to highlight `Jenkins`, press the spacebar to select, and then press 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 3 and press enter. + - At the GitHub PAT prompt, enter the GitHub PAT generated in step 3 and press enter. + - At the GitHub URL prompt, enter the GitHub instance URL or press enter to accept the default value (`https://github.com`). + - At the Jenkins token prompt, enter the Jenkins access token from step 2 and press enter. + - At the Jenkins URL prompt, enter `http://localhost:8080/` and press enter. + + ```console + $ gh valet configure + ✔ Which CI providers are you configuring?: Jenkins + Enter the following values (leave empty to omit): + ✔ GitHub handle used to authenticate with the GitHub Container Registry: mona + ✔ Personal access token to authenticate with the GitHub Container Registry: *************** + ✔ Personal access token for GitHub: *************** + ✔ Base url of the GitHub instance: https://github.com + ✔ Personal access token for Jenkins: *************** + ✔ Username of Jenkins user: admin + ✔ Base url of the Jenkins instance: https://localhost + Environment variables successfully updated. + ``` ## Verify your environment