Skip to content

more detailed instructions for using github container registry #5099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PhilBastian merged 2 commits into from
Aug 11, 2025
Merged

more detailed instructions for using github container registry #5099

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28b9c5a
more detailed instructions for using github container registry
PhilBastian Aug 8, 2025
d9822d7
Update instructions for cross OS compatibility
PhilBastian Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ Container images generated for all builds are pushed to the [GitHub container re
Containers built by a PR and stored on GitHub Container Registry can be tested locally:

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).
- Create a [classic token](https://github.com/settings/tokens). Select the scope for `read:packages`
- Copy the newly created token text.
- **On Windows**
- create an Environment Variable to store the token (e.g. GITHUB_TOKEN)
- open powershell
- run the command `echo $env:GITHUB_TOKEN | docker login ghcr.io -u <your particular email> --password-stdin`
Comment thread
PhilBastian marked this conversation as resolved.
Outdated
- ensure that you get a successful login message. use `docker logout ghcr.io` once the following steps are complete and consider removing the token from github if its no longer needed
2. In the terminal, navigate to `[/docs/test-ghcr-tag`](/docs/test/ghcr-tag).
3. Edit the [`.env` file](/docs/test-ghcr-tag/.env) to specify the PR-based tag (in the form `pr-####`) to test.
4. Run `docker compose up -d`.
Expand Down
Loading