Skip to content

Commit 2e756dc

Browse files
authored
more detailed instructions for using github container registry (#5099)
* more detailed instructions for using github container registry * Update instructions for cross OS compatibility
1 parent 78e1443 commit 2e756dc

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/testing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ Container images generated for all builds are pushed to the [GitHub container re
4343
Containers built by a PR and stored on GitHub Container Registry can be tested locally:
4444

4545
1. [Authenticate to the GitHub Container Registry using a personal access token](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
46+
- Create a [classic token](https://github.com/settings/tokens). Select the scope for `read:packages`
47+
- Copy the newly created token text.
48+
- Run the following command in a terminal:
49+
```shell
50+
docker login ghcr.io
51+
```
52+
you will be prompted for a username (your particular.net email) and a password (the token)
53+
- ensure that you get a successful login message.
54+
- Use `docker logout ghcr.io` once the following steps are complete and consider removing the token from github if its no longer needed
4655
2. In the terminal, navigate to `[/docs/test-ghcr-tag`](/docs/test/ghcr-tag).
4756
3. Edit the [`.env` file](/docs/test-ghcr-tag/.env) to specify the PR-based tag (in the form `pr-####`) to test.
4857
4. Run `docker compose up -d`.

0 commit comments

Comments
 (0)