Updating format and repo creation flow. (#3)
* Update readme.md * Update readme.md * Update readme.md * Update devcontainer.json * Update setupcodespace.sh * Update valet-audit-lab.md * Update valet-dry-run-lab.md * Update valet-migrate-lab.md * Update valet-migrate-custom-lab.md * Update valet-audit-lab.md * Update valet-audit-lab.md * Update valet-dry-run-lab.md * Update valet-migrate-lab.md * Update valet-migrate-custom-lab.md * Update valet-dry-run-lab.md * Update valet-migrate-custom-lab.md
This commit is contained in:
dkalmin
+13
-11
@@ -12,20 +12,22 @@ This lab bootstraps a Valet environment using GitHub Codespaces and enables you
|
||||
|
||||
## Repo template
|
||||
|
||||
1. Click `Use this template` to create this repository inside your GitHub organization.
|
||||
1. Verify you are in your own Repository created from the landing page [Valet Labs](https://github.com/valet-customers/labs).
|
||||
|
||||
## 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.
|
||||
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 differnt 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.
|
||||
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}`.
|
||||
- From your home page, open `user settings`, and then select `Personal access tokens`.
|
||||
- Click your `Account management` icon
|
||||
- Click `user settings`
|
||||
- Click `Personal access tokens`.
|
||||
- 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:
|
||||
- Select the following scopes (Click `Show more scopes` if you don't see all of the below):
|
||||
- Agents Pool: `Read`
|
||||
- Build: `Read & Execute`
|
||||
- Code: `Read & Write`
|
||||
@@ -57,7 +59,7 @@ 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 Codespaces 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`
|
||||
@@ -67,14 +69,14 @@ 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.
|
||||
|
||||
Steps to create the Codespace secret. Complete for secret noted above:
|
||||
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
|
||||
- Name the secret as noted above
|
||||
- Paste in the vale noted above
|
||||
- Paste in the value noted above
|
||||
- Click `Add Secret`
|
||||
|
||||
## Azure DevOps project creation
|
||||
@@ -97,14 +99,14 @@ Run the Actions workflow:
|
||||
## Use Valet with a codespace
|
||||
|
||||
1. Start the codespace
|
||||
- Click the `Code` button above repository
|
||||
- Click the `Code` with button down arrow above repository on the repository's landing page.
|
||||
- Click the `Codespaces` tab
|
||||
- Click `New Codespace`
|
||||
- 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
|
||||
- Run `gh valet version` in the Visual Studio Code terminal and verify the output looks like the below image.
|
||||
- If `gh valet version` did not produce a similar image please follow these instructions [Troubleshoot GH Valet extension](#troubleshoot-gh-valet-extension)
|
||||
- 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)
|
||||
|
||||
### Example ###
|
||||
|
||||
@@ -5,24 +5,12 @@ In this lab, you will use Valet to `audit` an Azure DevOps organization. The `au
|
||||
- [Perform an audit](#perform-an-audit)
|
||||
- [View audit output](#view-audit-output)
|
||||
- [Review the pipelines](#review-the-pipelines)
|
||||
- [Next Lab](#next-lab)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Follow all steps [here](/labs/azure_devops#readme) to set up your environment
|
||||
1. Follow all steps [here](../azure_devops#readme) to set up your environment
|
||||
2. Create or start a codespace in this repository (if not started)
|
||||
3. Verify or add the following values to the `valet/.env.local` file. All values were created [here](/labs/azure_devops#readme)
|
||||
```
|
||||
GITHUB_ACCESS_TOKEN=<GithHub PAT generated>
|
||||
GITHUB_INSTANCE_URL=https://github.com/
|
||||
|
||||
AZURE_DEVOPS_PROJECT=<Project identified>
|
||||
AZURE_DEVOPS_ORGANIZATION=<Org identified>
|
||||
AZURE_DEVOPS_INSTANCE_URL=<DevOps instance>
|
||||
AZURE_DEVOPS_ACCESS_TOKEN=<Token Generated>
|
||||
```
|
||||
### Example ###
|
||||
|
||||
|
||||
|
||||
## Perform an audit
|
||||
You will use the codespace preconfigured in this repository to perform the audit.
|
||||
@@ -60,3 +48,5 @@ The `audit` command grabs the yml, classic, and release pipelines from Azure Dev
|
||||
View the source yml and the proposed GitHub yml
|
||||
|
||||
|
||||
### Next Lab
|
||||
[Dry run the migration of an Azure DevOps pipeline to GitHub Actions](valet-dry-run-lab.md)
|
||||
|
||||
@@ -5,30 +5,18 @@ In this lab, you will use the `valet dry-run` command to convert an Azure DevOps
|
||||
- [Identify the Azure DevOps pipeline ID to use](#identify-the-azure-devops-pipeline-id-to-use)
|
||||
- [Perform a dry run](#perform-a-dry-run)
|
||||
- [View dry-run output](#view-dry-run-output)
|
||||
- [Next Lab](#next-lab)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Follow all steps [here](/labs/azure_devops#readme) to set up your environment
|
||||
1. Follow all steps [here](../azure_devops#readme) to set up your environment
|
||||
2. Create or start a codespace in this repository (if not started)
|
||||
3. You have completed the [Valet audit lab](valet-audit-lab.md).
|
||||
4. Verify or add the following values to the `valet/.env.local` file. All values were created [here](/labs/azure_devops#readme)
|
||||
```
|
||||
GITHUB_ACCESS_TOKEN=<GithHub PAT generated>
|
||||
GITHUB_INSTANCE_URL=https://github.com/
|
||||
|
||||
AZURE_DEVOPS_PROJECT=<Project identified>
|
||||
AZURE_DEVOPS_ORGANIZATION=<Org identified>
|
||||
AZURE_DEVOPS_INSTANCE_URL=<DevOps instance>
|
||||
AZURE_DEVOPS_ACCESS_TOKEN=<Token Generated>
|
||||
```
|
||||
### Example ###
|
||||
|
||||
|
||||
|
||||
## Identify the Azure DevOps pipeline ID to use
|
||||
You will need a pipeline ID to perform the dry run
|
||||
1. Go to the `valet/ValetBootstrap/pipelines` folder
|
||||
2. Open the `valet/ValetBootstrap/pipelines/valet-pipeline1.json` file
|
||||
2. Open the `valet/ValetBootstrap/pipelines/valet-pipeline1.config.json` file
|
||||
3. Look for the `$.web.href` link
|
||||
4. At the end of the link is the pipeline ID. Copy or note the ID.
|
||||
|
||||
@@ -60,3 +48,5 @@ The dry-run output will show you the GitHub Actions yml that will be migrated to
|
||||
### Example
|
||||
|
||||
|
||||
### Next Lab
|
||||
[Migrate an Azure DevOps pipeline to GitHub Actions](valet-migrate-lab.md)
|
||||
|
||||
@@ -8,23 +8,10 @@ In this lab, you will create a custom plugin that transforms some of the existin
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Follow all steps [here](/labs/azure_devops#readme) to set up your environment
|
||||
1. Follow all steps [here](../azure_devops#readme) to set up your environment
|
||||
2. Create or start a codespace in this repository (if not started)
|
||||
3. Complete the [Valet audit lab](valet-audit-lab.md).
|
||||
4. Complete the [Valet migrate lab](valet-migrate-lab.md).
|
||||
5. Verify or add the following values to the `./valet/.env.local` file. All values were created [here](/labs/azure_devops#readme)
|
||||
```
|
||||
GITHUB_ACCESS_TOKEN=<GithHub PAT generated>
|
||||
GITHUB_INSTANCE_URL=https://github.com/
|
||||
|
||||
AZURE_DEVOPS_PROJECT=<Project identified>
|
||||
AZURE_DEVOPS_ORGANIZATION=<Org identified>
|
||||
AZURE_DEVOPS_INSTANCE_URL=<DevOps instance>
|
||||
AZURE_DEVOPS_ACCESS_TOKEN=<Token Generated>
|
||||
```
|
||||
### Example ###
|
||||
|
||||
|
||||
|
||||
## Identify the Azure DevOps pipeline ID to use
|
||||
You will need the `valet-mapper-example` Azure DevOps pipeline ID to perform the migration
|
||||
@@ -34,7 +21,7 @@ You will need the `valet-mapper-example` Azure DevOps pipeline ID to perform the
|
||||
4. At the end of the link is the pipeline ID. Copy or note the ID.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
|
||||
## Create a custom transformer
|
||||
|
||||
|
||||
@@ -5,25 +5,13 @@ In this lab, you will use the Valet `migrate` command to migrate an Azure DevOps
|
||||
- [Identify the Azure DevOps pipeline ID to use](#identify-the-azure-devops-pipeline-id-to-use)
|
||||
- [Perform a migration](#perform-a-migration)
|
||||
- [View the pull request](#view-the-pull-request)
|
||||
- [Next Lab](#next-lab)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. Follow all steps [here](/labs/azure_devops#readme) to set up your environment
|
||||
1. Follow all steps [here](../azure_devops#readme) to set up your environment
|
||||
2. Create or start a codespace in this repository (if not started)
|
||||
3. Completed the [Valet audit lab](valet-audit-lab.md).
|
||||
4. Verify or add the following values to the `./valet/.env.local` file. All values were created [here](/labs/azure_devops#readme)
|
||||
```
|
||||
GITHUB_ACCESS_TOKEN=<GithHub PAT generated>
|
||||
GITHUB_INSTANCE_URL=https://github.com/
|
||||
|
||||
AZURE_DEVOPS_PROJECT=<Project identified>
|
||||
AZURE_DEVOPS_ORGANIZATION=<Org identified>
|
||||
AZURE_DEVOPS_INSTANCE_URL=<DevOps instance>
|
||||
AZURE_DEVOPS_ACCESS_TOKEN=<Token Generated>
|
||||
```
|
||||
### Example ###
|
||||
|
||||
|
||||
|
||||
## Identify the Azure DevOps pipeline ID to use
|
||||
You will need a pipeline ID to perform the migration
|
||||
@@ -67,3 +55,6 @@ The migrate output will show you the pull request on GitHub.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
### Next Lab
|
||||
[Migrate an Azure DevOps pipeline to GitHub Actions with a custom transformer](valet-migrate-custom-lab.md)
|
||||
|
||||
Reference in New Issue
Block a user