diff --git a/circle_ci/4-dry-run.md b/circle_ci/4-dry-run.md index 84ff5fe..0d745f5 100644 --- a/circle_ci/4-dry-run.md +++ b/circle_ci/4-dry-run.md @@ -16,7 +16,7 @@ You will be performing a dry run migration against a CircleCI project. Answer th - __circleci-demo-ruby-rails__. This is one of the sample projects avaiable in the CircleCI valet-labs organization. 2. Where do you want to store the result? - - __tmp/dry-run-lab__. This can be any path within the working directory that Valet commands are executed from. + - __tmp/dry-run__. This can be any path within the working directory that Valet commands are executed from. ### Steps @@ -24,20 +24,20 @@ You will be performing a dry run migration against a CircleCI project. Answer th 2. Run the following command from the root directory: ```bash - gh valet dry-run circle-ci --output-dir tmp/dry-run-lab --circle-ci-project circleci-demo-ruby-rails + gh valet dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project circleci-demo-ruby-rails ``` 3. The command will list all the files written to disk when the command succeeds. ```console - $ gh valet dry-run circle-ci --output-dir tmp/dry-run-lab --circle-ci-project circleci-demo-ruby-rails --circle-ci-organization valet-labs - [2022-09-19 19:46:03] Logs: 'tmp/dry-run-lab/log/valet-20220919-194603.log' + $ gh valet dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project circleci-demo-ruby-rails --circle-ci-organization valet-labs + [2022-09-19 19:46:03] Logs: 'tmp/dry-run/log/valet-20220919-194603.log' [2022-09-19 19:46:05] Output file(s): - [2022-09-19 19:46:05] tmp/dry-run-lab/valet-labs/circleci-demo-ruby-rails/build_and_test.yml + [2022-09-19 19:46:05] tmp/dry-run/valet-labs/circleci-demo-ruby-rails/build_and_test.yml ``` 4. View the converted workflow: - - Find `tmp/dry-run-lab/valet-labs/circleci-demo-ruby-rails` in the file explorer pane in your codespace. + - Find `tmp/dry-run/valet-labs/circleci-demo-ruby-rails` in the file explorer pane in your codespace. - Click `build_and_test.yml` to open. ## Inspect the output files diff --git a/circle_ci/readme.md b/circle_ci/readme.md index dbaa3bc..3131b01 100644 --- a/circle_ci/readme.md +++ b/circle_ci/readme.md @@ -12,28 +12,29 @@ These steps **must** be completed prior to starting other labs. 1. Start a new Codespace. -- Click the `Code` with button down arrow above repository on the repository's landing page. -- Click the `Codespaces` tab -- Click `Create codespaces on main` to create the codespace. -- After the Codespace has initialized there will be a terminal present. + - Click the `Code` with button down arrow above repository on the repository's landing page. + - Click the `Codespaces` tab + - Click `Create codespaces on main` to create the codespace. + - After the Codespace has initialized there will be a terminal present. 2. Verify the Valet CLI is installed and working. More information on the Valet extension for the official GitHub CLI can be found [here](https://github.com/github/gh-valet). -- Run the following command in the codespace's terminal: + - Run the following command in the codespace's terminal: - ```bash - gh valet version - ``` + ```bash + gh valet version + ``` -- Verify the output is similar to below. The version information may differ than what is shown below, it is expected that the `valet-cli` version is unknown. This will be corrected in the [configure credentials for Valet](1-configure.md) lab. + - Verify the output is similar to below. - ```bash - gh version 2.14.3 (2022-07-26) - gh valet github/gh-valet v0.1.12 - valet-cli unknown - ``` + ```console + $ gh valet version + gh version 2.14.3 (2022-07-26) + gh valet github/gh-valet v0.1.12 + valet-cli unknown + ``` - - If `gh valet version` did not produce similar output then please follow the troubleshooting [guide](#troubleshoot-the-valet-cli). + - If `gh valet version` did not produce similar output, refer to the troubleshooting [guide](#troubleshoot-the-valet-cli). ## Labs for CircleCI @@ -59,7 +60,8 @@ The CLI extension for Valet can be manually installed by following these steps: - Verify the result of the install contains: - ```bash + ```console + $ gh extension install github/gh-valet ✓ Installed extension github/gh-valet ```