Update readme.md
This commit is contained in:
+28
-12
@@ -23,7 +23,8 @@ These steps **must** be completed prior to starting other labs.
|
|||||||
gh valet version
|
gh valet version
|
||||||
```
|
```
|
||||||
|
|
||||||
- Verify the output is similar to below, if not try manually installing the valet extension, using the [troubleshooting](#troubleshooting) section.
|
- Verify the output is similar to below.
|
||||||
|
- If `gh valet version` did not produce similar output then please follow the troubleshooting [guide](#troubleshoot-the-valet-cli).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gh version 2.14.3 (2022-07-26)
|
gh version 2.14.3 (2022-07-26)
|
||||||
@@ -44,7 +45,9 @@ valet-cli unknown
|
|||||||
- Verify that you can see the auto populated projects in GitLab, under the `valet` namespace by clicking the `Menu` icon in GitLab, then `Your projects`.
|
- Verify that you can see the auto populated projects in GitLab, under the `valet` namespace by clicking the `Menu` icon in GitLab, then `Your projects`.
|
||||||
|
|
||||||
## Labs for GitLab
|
## Labs for GitLab
|
||||||
|
|
||||||
Perform the following labs to test-drive Valet
|
Perform the following labs to test-drive Valet
|
||||||
|
|
||||||
1. [Configure credentials for Valet](1-configure.md)
|
1. [Configure credentials for Valet](1-configure.md)
|
||||||
2. [Perform an audit on GitLab pipelines](2-audit.md)
|
2. [Perform an audit on GitLab pipelines](2-audit.md)
|
||||||
3. [Perform a dry-run of a GitLab pipeline](3-dry-run.md)
|
3. [Perform a dry-run of a GitLab pipeline](3-dry-run.md)
|
||||||
@@ -52,15 +55,28 @@ Perform the following labs to test-drive Valet
|
|||||||
5. [Forecast potential build runner usage](5-forecast.md)
|
5. [Forecast potential build runner usage](5-forecast.md)
|
||||||
6. [Perform a production migration of a GitLab pipeline](6-migrate.md)
|
6. [Perform a production migration of a GitLab pipeline](6-migrate.md)
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshoot the Valet CLI
|
||||||
- **GitHub CLI Valet extension is not installed**. More information on the [GitHub Valet CLI extension](https://github.com/github/gh-valet)
|
|
||||||
|
The CLI extension for Valet can be manually installed by following these steps:
|
||||||
|
|
||||||
- Verify you are in the codespace terminal
|
- Verify you are in the codespace terminal
|
||||||
- Run `gh extension install github/gh-valet`
|
- Run this command from within the codespace's terminal:
|
||||||
- Verify the result of the command is: `✓ Installed extension github/gh-valet`
|
|
||||||
- If you get a similar error to the following, click the link to authorize the token
|
```bash
|
||||||

|
gh extension install github/gh-valet
|
||||||
- Restart the codespace after clicking the link
|
```
|
||||||
- **Port 80 is not being forwarded for GitLab server**. This should be auto detected by codespaces, but can be manually setup by:
|
|
||||||
- In the codespace terminal click the PORTS tab
|
- Verify the result of the install contains:
|
||||||
- Click the "Add Port" button
|
|
||||||
- Enter 80 and hit enter
|
```bash
|
||||||
|
✓ Installed extension github/gh-valet
|
||||||
|
```
|
||||||
|
|
||||||
|
- If you get an error similar to the image below, then click the link in the terminal output to authorize the token.
|
||||||
|
- Restart the codespace after clicking the link.
|
||||||
|

|
||||||
|
- Verify Valet CLI extension is installed and working by running the following command from the codespace's terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gh valet version
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user