actions/importer-labs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Begona Guereca
2022-08-25 16:41:40 -07:00
committed by GitHub
parent 71e2d69424
commit b69f1c8fee
1 changed files with 43 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
azure_devops/readme.md
+39 -30
View File
@@ -15,29 +15,30 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you
1. Verify you are in your own Repository created from the landing page [Valet Labs](https://github.com/valet-customers/labs). 1. Verify you are in your own Repository created from the landing page [Valet Labs](https://github.com/valet-customers/labs).
## Prerequisites ## 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) 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 DevOps organization name for later. - 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. - 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. 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. - Note and store the Azure DevOps project name for later.
3. Create an Azure DevOps personal access token with the following scopes: 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}`. - To do so, navigate to Sign in to your organization `https://dev.azure.com/{yourorganization}`.
- Click your `Account management` icon - Click your `Account management` icon
- Click `User settings`. - Click `User settings`.
- Click `Personal access tokens`. - 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. - 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` to ensure you see all of the following): - Select the following scopes (Click `Show more scopes` to ensure you see all of the following):
- Agents Pool: `Read` - Agents Pool: `Read`
- Build: `Read & Execute` - Build: `Read & Execute`
- Code: `Read & Write` - Code: `Read & Write`
- Project and Team: `Read, Write, & Manage` - Project and Team: `Read, Write, & Manage`
- Release: `Read` - Release: `Read`
- Service Connections: `Read` - Service Connections: `Read`
- Task Groups: `Read` - Task Groups: `Read`
- Variable Groups: `Read` - Variable Groups: `Read`
- Click `Create`. - Click `Create`.
- Copy the PAT somewhere safe and temporary. - Copy the PAT somewhere safe and temporary.
4. Create a GitHub personal access token. 4. Create a GitHub personal access token.
- To do so, navigate to your GitHub `Settings` - click your profile photo and then click `Settings`. - To do so, navigate to your GitHub `Settings` - click your profile photo and then click `Settings`.
- Go to `Developer settings`. - Go to `Developer settings`.
@@ -48,6 +49,7 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you
- Copy the PAT somewhere safe and temporary. - Copy the PAT somewhere safe and temporary.
## Codespace secrets ## Codespace secrets
Please add the following 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`.
@@ -66,6 +68,7 @@ Steps to create the Codespace secrets. Complete for secret noted above:
- Click `Add secret` - Click `Add secret`
## Action secrets ## Action secrets
Please add the following Action secrets. Please add the following Action secrets.
- `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_ACCESS_TOKEN`: Add `AZURE_DEVOPS_ACCESS_TOKEN` as the `Name` and the Azure DevOps personal access token created above as the value.
@@ -83,19 +86,20 @@ Steps to create the Actions secret. Complete for secret noted above:
## Azure DevOps project creation ## Azure DevOps project creation
Run the Actions workflow: Run the Actions workflow:
- CLick the `Actions` tab - CLick the `Actions` tab
- Select the `Valet Bootstrap for Azure DevOps` action - Select the `Valet Bootstrap for Azure DevOps` action
- Click `Run workflow` - Click `Run workflow`
- Input the Azure DevOps organization name identified above - 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 - 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 - 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. - 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` - Click `Run workflow`
- Verify the workflow completed successfully. If the workflow did not run successfully you will see a detailed error message. - Verify the workflow completed successfully. If the workflow did not run successfully you will see a detailed error message.
### Example ### ### Example ###
![runaction](https://user-images.githubusercontent.com/26442605/167679930-9bdf6f4f-2e94-4145-aed3-8ee3e8e91d90.png)
![runaction](https://user-images.githubusercontent.com/26442605/167679930-9bdf6f4f-2e94-4145-aed3-8ee3e8e91d90.png)
## Use Valet with a codespace ## Use Valet with a codespace
@@ -106,16 +110,19 @@ Run the Actions workflow:
- 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. - 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. - 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) 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. - 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). - 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). - Start using Valet by following along with the [Labs for Azure DevOps](#labs-for-azure-devops).
### Example ### ### Example ###
![gh-valet-version](https://user-images.githubusercontent.com/26442605/170106559-e69e669f-a1f6-4c2c-8998-3f089b899704.png) ![gh-valet-version](https://user-images.githubusercontent.com/26442605/170106559-e69e669f-a1f6-4c2c-8998-3f089b899704.png)
## Labs for Azure DevOps ## Labs for Azure DevOps
Perform the following labs to test-drive Valet Perform the following labs to test-drive Valet
- [Audit Azure DevOps pipelines using the Valet audit command](valet-audit-lab.md) - [Audit Azure DevOps pipelines using the Valet audit command](valet-audit-lab.md)
- [Dry run the migration of an Azure DevOps pipeline to GitHub Actions](valet-dry-run-lab.md) - [Dry run the migration of an Azure DevOps pipeline to GitHub Actions](valet-dry-run-lab.md)
- [Migrate an Azure DevOps pipeline to GitHub Actions](valet-migrate-lab.md) - [Migrate an Azure DevOps pipeline to GitHub Actions](valet-migrate-lab.md)
@@ -123,12 +130,14 @@ Perform the following labs to test-drive Valet
- [Forecast: Valet forecast lab](valet-forecast-lab.md) - [Forecast: Valet forecast lab](valet-forecast-lab.md)
## Troubleshoot GH Valet extension ## Troubleshoot GH Valet extension
Manually Install the GitHub CLI Valet extension. More information on the [GitHub Valet CLI extension](https://github.com/github/gh-valet) Manually Install the GitHub CLI Valet extension. More information on the [GitHub Valet CLI extension](https://github.com/github/gh-valet)
- Verify you are in the Visual Studio Code terminal
- Run this command to install the GitHub Valet extension - Verify you are in the Visual Studio Code terminal
- `gh extension install github/gh-valet` - Run this command to install the GitHub Valet extension
- Verify the result of the install is: `✓ Installed extension github/gh-valet` - `gh extension install github/gh-valet`
- If you get a similiar error to the following, click the link to authorize the token - Verify the result of the install is: `✓ Installed extension github/gh-valet`
- If you get a similiar error to the following, click the link to authorize the token
![linktolcickauth](https://user-images.githubusercontent.com/26442605/169588015-9414404f-82b6-4d0f-89d4-5f0e6941b029.png) ![linktolcickauth](https://user-images.githubusercontent.com/26442605/169588015-9414404f-82b6-4d0f-89d4-5f0e6941b029.png)
- Restart Codespace after clicking the link - Restart Codespace after clicking the link
- Verify Valet CLI is installed and working - Verify Valet CLI is installed and working