diff --git a/azure_devops/1-configure.md b/azure_devops/1-configure.md index 2d82ea9..6f0795d 100644 --- a/azure_devops/1-configure.md +++ b/azure_devops/1-configure.md @@ -8,7 +8,7 @@ You will need to complete all of the setup instructions [here](./readme.md#confi 1. Create an Azure DevOps Personal Access Token (PAT). 1. __Note__: you may skip this step if you still have the PAT created during the setup steps [here](./readme.md#bootstrap-your-azure-devops-organization). - 2. Navigate to your existing organization () in your browswer. + 2. Navigate to your existing organization () in your browser. 3. Click `User settings` in the top right corner of the screen. 4. Click `Personal access tokens`. 5. Select `+ New Token` diff --git a/azure_devops/2-audit.md b/azure_devops/2-audit.md index 8253190..f40b306 100644 --- a/azure_devops/2-audit.md +++ b/azure_devops/2-audit.md @@ -31,7 +31,7 @@ We will be performing an audit against the bootstrapped Azure DevOps project. We gh valet audit azure-devops --output-dir tmp/audit --namespace valet ``` - __Note__: The Azure DevOps organization and project name can be omitted from the `audit` command as they were persited in the `.env.local` file in the [configure lab](./1-configure.md). You can optionally provide these arguments on the command line with the `--azure-devops-organization` and `--azure-devops-project` CLI options. + __Note__: The Azure DevOps organization and project name can be omitted from the `audit` command as they were persisted in the `.env.local` file in the [configure lab](./1-configure.md). You can optionally provide these arguments on the command line with the `--azure-devops-organization` and `--azure-devops-project` CLI options. 3. The command will list all the files written to disk in green when the command succeeds. diff --git a/azure_devops/3-dry-run.md b/azure_devops/3-dry-run.md index c199cee..3aa2db9 100644 --- a/azure_devops/3-dry-run.md +++ b/azure_devops/3-dry-run.md @@ -23,7 +23,7 @@ We will be performing a dry-run for a pipeline in the bootstrapped Azure DevOps ### Steps -1. Navigate to the codespace terminal +1. Navigate to the codespace terminal. 2. Run the following command from the root directory: ```bash diff --git a/azure_devops/4-custom-transformers.md b/azure_devops/4-custom-transformers.md index e0c8b95..c13ef4d 100644 --- a/azure_devops/4-custom-transformers.md +++ b/azure_devops/4-custom-transformers.md @@ -81,7 +81,7 @@ _Note_: You can refer to the previous [lab](./3-dry-run.md) to learn about the f ## Custom transformers for build steps -We can use custom transformers override Valet's default behavior. In this scenario, we may want to override the behavior for converting `DotnetCoreCLI@2` tasks to support parameters that are glob patterns. We will need to answer the following questions before writing a custom transformer: +We can use custom transformers to override Valet's default behavior. In this scenario, we may want to override the behavior for converting `DotnetCoreCLI@2` tasks to support parameters that are glob patterns. We will need to answer the following questions before writing a custom transformer: 1. What is the "identifier" of the step to customize? - __DotnetCoreCLI@2__ @@ -170,7 +170,7 @@ env: Finally, we can use custom transformers to dictate which runners converted workflows should use. To do this we will need to answer the following questions: -1. What is label of the runner in Azure DevOps to update? +1. What is the label of the runner in Azure DevOps to update? - __mechamachine__ 2. What is the label of the runner in Actions to use instead? diff --git a/azure_devops/5-migrate.md b/azure_devops/5-migrate.md index 2d582e0..5ef8212 100644 --- a/azure_devops/5-migrate.md +++ b/azure_devops/5-migrate.md @@ -21,7 +21,7 @@ We need to answer the following questions before running a `migrate` command: 2. Where do we want to store the logs? - __./tmp/migrate__ 3. What is the URL for the GitHub repository to add the workflow to? - - __this repository__. The URL should should follow the pattern with `:owner` and `:repo` replaced with your values. + - __this repository__. The URL should follow the pattern with `:owner` and `:repo` replaced with your values. ### Steps @@ -47,11 +47,9 @@ The first thing we should notice about the PR is that there is a list of manual ![img](https://user-images.githubusercontent.com/8703324/189002125-45561312-dd26-42fd-bd38-a596614ee871.png) -Next, let's review the workflow we are adding by clicking on `Files changed` tab. This is where you would double check everything looks good. If it didn't you could push commits with the required changes, prior to merging. +Next, you can inspect the `Files changed` in this PR and see the converted workflow that is being added. Any additional changes or code reviews that were needed should be done in this PR. -Next, you can inspect the "Files changed" in this PR and see the converted workflow that is being added. Any additional changes or code reviews that were needed should be done in this PR. - -Finally, you can merge the PR once your review has completed. We can then view the workflow running by selecting the "Actions" menu in the top navigation bar in GitHub. +Finally, you can merge the PR once your review has completed. We can then view the workflow running by selecting the `Actions` menu in the top navigation bar in GitHub. ![img](https://user-images.githubusercontent.com/19557880/185509704-90243ec5-e77f-4baf-a9b2-d9a4d9fda199.png) diff --git a/azure_devops/6-forecast.md b/azure_devops/6-forecast.md index 9603f3c..d413a55 100644 --- a/azure_devops/6-forecast.md +++ b/azure_devops/6-forecast.md @@ -22,14 +22,14 @@ We will need to answer the following questions before running the `forecast` com ### Steps -1. Navigate to the codespace terminal +1. Navigate to the codespace terminal. 2. Run the following command from the root directory: ```bash gh valet forecast azure-devops --output-dir ./tmp/forecast_reports --azure-devops-project :project ``` -3. The command will output a message stating that "No jobs found" because no jobs have been executed in your bootstrapped project. +3. The command will output a message that says "No jobs found" because no jobs have been executed in your bootstrapped project. ![img](https://user-images.githubusercontent.com/18723510/187690315-6312088d-9888-4c55-9bbf-c6f2687fa547.png) @@ -57,7 +57,7 @@ The forecast report, logs, and completed job data will be located within the `tm ### Total -The "Total" section of the forecast report contains high level statistics related to all the jobs completed after the `--start-date` CLI option: +The `Total` section of the forecast report contains high level statistics related to all the jobs completed after the `--start-date` CLI option: ```md - Job count: **84** @@ -88,8 +88,8 @@ The "Total" section of the forecast report contains high level statistics relate Here are some key terms of items defined in the forecast report: -- The `job count` is the total number of completed jobs. -- The `pipeline count` is the number of unique pipelines used. +- The `Job count` is the total number of completed jobs. +- The `Pipeline count` is the number of unique pipelines used. - `Execution time` describes the amount of time a runner spent on a job. This metric can be used to help plan for the cost of GitHub hosted runners. - This metric is correlated to how much you should expect to spend in GitHub Actions. This will vary depending on the hardware used for these minutes and the [Actions pricing calculator](https://github.com/pricing/calculator) should be used to estimate a dollar amount. - `Queue time` metrics describe the amount of time a job spent waiting for a runner to be available to execute it.