From 86d018931bc673e7216b3075be226a7fb7bf4315 Mon Sep 17 00:00:00 2001 From: Begona Guereca Date: Thu, 25 Aug 2022 09:46:25 -0700 Subject: [PATCH] Merged with main --- .github/CODEOWNERS | 1 + azure_devops/readme.md | 51 +++++++++++++++++++++--------------------- readme.md | 16 ++++++------- 3 files changed, 35 insertions(+), 33 deletions(-) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..d1459bf --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @valet-customers/reviewers diff --git a/azure_devops/readme.md b/azure_devops/readme.md index ba0c2e5..b3bf848 100644 --- a/azure_devops/readme.md +++ b/azure_devops/readme.md @@ -16,18 +16,18 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you ## Prerequisites 1. Azure DevOps organization. Please identify or create an Azure DevOps organization to use: [Click to create an Azure DevOps Org](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/create-organization?toc=%2Fazure%2Fdevops%2Fget-started%2Ftoc.json&bc=%2Fazure%2Fdevops%2Fget-started%2Fbreadcrumb%2Ftoc.json&view=azure-devops) - - Note and store the Azure DevOp sorganization name for later. - - Note and store the user name you use for your Azure DevOps Organization. It will be an email address. + - Note and store the Azure DevOps organization name for later. + - Note and store the username you use for your Azure DevOps organization. It will be an email address. 2. Azure DevOps Project. The default project name for this lab is `ValetBootstrap` There is an Action workflow that will create and populate the Azure DevOps project. No need to create it yourself. Note: The project has to be unique in the Azure DevOps organization. If you already have a project name `ValetBootstrap` please pick a different unique project name. - Note and store the Azure DevOps project name for later. 3. Create an Azure DevOps personal access token with the following scopes: - To do so, navigate to Sign in to your organization `https://dev.azure.com/{yourorganization}`. - - Click your `Account management` icon - - Click `user settings` + - Click your `Account management` icon < ===================== I didn't see this + - Click `User settings`. - Click `Personal access tokens`. - - Select `+ New Token` + - Select `+ New Token`. - Name your token, select the organization where you want to use the token, and then set your token to automatically expire after a set number of days. - - Select the following scopes (Click `Show more scopes` if you don't see all of the below): + - Select the following scopes (Click `Show more scopes` to ensure you see all of the following): - Agents Pool: `Read` - Build: `Read & Execute` - Code: `Read & Write` @@ -36,34 +36,34 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you - Service Connections: `Read` - Task Groups: `Read` - Variable Groups: `Read` - - Click `Create` + - Click `Create`. - Copy the PAT somewhere safe and temporary. 4. Create a GitHub personal access token. - To do so, navigate to your GitHub `Settings` - click your profile photo and then click `Settings`. - - Go to `Developer Settings` - - Go to `Personal Access Tokens` -> `Legacy tokens (if present)` + - Go to `Developer settings`. + - Go to `Personal access tokens` -> `Legacy tokens (if present)` - Click `Generate new token` -> `Legacy tokens (if present)`. If required, provide your password. - Select at least these scopes: `read packages` and `workflow`. Optionally, provide a text in the **Note** field and change the expiration. - - Click `Generate token` + - Click `Generate token`. - Copy the PAT somewhere safe and temporary. ## Codespace secrets Please add the following Codespace secrets. -- `VALET_GHCR_PASSWORD`: Add `VALET_GHCR_PASSWORD` as the `Name` and the GitHub personal access token created above as the value. +- `VALET_GHCR_PASSWORD`: Add `VALET_GHCR_PASSWORD` as the `Name` and the GitHub personal access token created above as the `Value`. - `AZURE_DEVOPS_ACCESS_TOKEN`: Add `AZURE_DEVOPS_ACCESS_TOKEN` as the `Name` and the Azure DevOps personal access token created above as the value. -- `AZURE_DEVOPS_ORGANIZATION`: Add `AZURE_DEVOPS_ORGANIZATION` as the `Name` and the Azure DevOps organization noted above as the value. -- `AZURE_DEVOPS_PROJECT`: Add `AZURE_DEVOPS_PROJECT` as the `Name` and the Azure DevOps project noted above as the value. +- `AZURE_DEVOPS_ORGANIZATION`: Add `AZURE_DEVOPS_ORGANIZATION` as the `Name` and the Azure DevOps organization noted above as the `Value`. +- `AZURE_DEVOPS_PROJECT`: Add `AZURE_DEVOPS_PROJECT` as the `Name` and `ValetBootstrap` as the `Value`. Steps to create the Codespace secrets. Complete for secret noted above: - Navigate to the `Settings` tab in this repo - Find `Secrets` and click the down arrow - Click `Codespaces` -- Click `New Repository Secret` to create a new secret +- Click `New repository secret` to create a new secret - Name the secret as noted above - Paste in the value noted above -- Click `Add Secret` +- Click `Add secret` ## Action secrets Please add the following Action secrets. @@ -75,22 +75,22 @@ Steps to create the Actions secret. Complete for secret noted above: - Navigate to the `Settings` tab in this repo - Find `Secrets` and click the down arrow - Click `Actions` -- Click `New Repository Secret` to create a new secret +- Click `New repository secret` to create a new secret - Name the secret as noted above - Paste in the value noted above -- Click `Add Secret` +- Click `Add secret` ## Azure DevOps project creation Run the Actions workflow: - CLick the `Actions` tab - Select the `Valet Bootstrap for Azure DevOps` action -- Click `Run Workflow` -- Input the Azure DevOps Organization name identified above +- Click `Run workflow` +- Input the Azure DevOps organization name identified above - Input the Azure DevOps user name of the user that created the Azure DevOps PAT above. This will be an email address - Accept the default Azure DevOps project name or change it to one of your preference - - NOTE: The default project name is `ValetBootstrap`. This must be unique in your Azure DevOps Organization. If not, please choose a unique name. -- Click `Run Workflow` + - NOTE: The default project name is `ValetBootstrap`. This must be unique in your Azure DevOps organization. If not, please choose a unique name. +- Click `Run workflow` - Verify the workflow completed successfully. If the workflow did not run successfully you will see a detailed error message. ### Example ### @@ -100,15 +100,16 @@ Run the Actions workflow: ## Use Valet with a codespace 1. Start the codespace + - Navigate to the `< > Code` tab within your GitHub repository. - Click the `Code` with button down arrow above repository on the repository's landing page. - - Click the `Codespaces` tab + - 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 will 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 termininal 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) - - Verify Valet CLI is installed and working + - Verify Valet CLI is installed and working. - Run `gh valet version` in the Visual Studio Code terminal and verify the output looks like the below image. Note the valet version will be different than below as the latest version gets pulled down. - - If `gh valet version` did not produce a similar image with a version please follow these instructions [Troubleshoot GH Valet extension](#troubleshoot-gh-valet-extension) - - Start using Valet by following along with the [Labs for Azure DevOps](#labs-for-azure-devops) + - If `gh valet version` did not produce a similar image with a version please follow these instructions [Troubleshoot GH Valet extension](#troubleshoot-gh-valet-extension). + - Start using Valet by following along with the [Labs for Azure DevOps](#labs-for-azure-devops). ### Example ### ![gh-valet-version](https://user-images.githubusercontent.com/26442605/170106559-e69e669f-a1f6-4c2c-8998-3f089b899704.png) diff --git a/readme.md b/readme.md index cefd92e..4234af4 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,8 @@ # Welcome to Valet labs -These Valet labs let you test-drive Valet by bootstrapping the environment of your choosing. To get started: +These Valet labs let you test drive Valet by bootstrapping the environment of your choosing. To get started: -1. Get access to Valet and create your own GitHub Repository. See [Prerequisites](#prerequisites) below. +1. Get access to Valet and create your own GitHub repository. See the [Prerequisites](#prerequisites) below. 2. Bootstrap your environment. The default page of the lab of your choosing will detail how to configure and run the action to bootstrap the environment. Currently these labs support [Azure DevOps](azure_devops) and [Jenkins](jenkins). 3. Run Valet via Codespaces. The codespace has docker running and will update to the latest Valet environment. 4. Proceed with running the labs! @@ -10,12 +10,12 @@ These Valet labs let you test-drive Valet by bootstrapping the environment of yo # Prerequisites 1. Valet is currently private and customers must be onboarded prior to using it. Please reach out to [GitHub Sales](https://github.com/enterprise/contact) to inquire about being granted access. -2. Create your own GitHub Repository in your own GitHub Organization or under your user with Codespaces enabled using this Repository as a template. To do so: - - Navigate to the top of this Repository click `Use this template` - - Select the owner of the new Reposiotry. It could be your personal username or an Organization you belong to. - - Name the Repository - - Click `Create repository froom template` - - Proceed to the labs inside of your new Repository. +2. Create your own GitHub repository in your own GitHub organization or under your user with Codespaces enabled using this repository as a template. To do so: + - Navigate to the top of this repository and click `Use this template`. + - Select the owner of the new repository. It could be your personal username or an organization you belong to. + - Name the repository. + - Click `Create repository from template`. + - Proceed to the labs inside your new repository. ![createtemplate](https://user-images.githubusercontent.com/26442605/174847176-0e515fd3-8107-43e0-af33-70b1ece36d3b.png)