From 28b9c5a81e266ff5b41cb45e009b7117789b770f Mon Sep 17 00:00:00 2001 From: Phil Bastian <155411597+PhilBastian@users.noreply.github.com> Date: Fri, 8 Aug 2025 13:29:36 +0800 Subject: [PATCH 1/2] more detailed instructions for using github container registry --- docs/testing.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/testing.md b/docs/testing.md index 5e826996af..56e6cbebb5 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -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 --password-stdin` + - 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`. From d9822d750965a195496a93c628b02e732f3c6d82 Mon Sep 17 00:00:00 2001 From: Phil Bastian <155411597+PhilBastian@users.noreply.github.com> Date: Mon, 11 Aug 2025 13:37:29 +0800 Subject: [PATCH 2/2] Update instructions for cross OS compatibility --- docs/testing.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/testing.md b/docs/testing.md index 56e6cbebb5..7fd543534d 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -45,11 +45,13 @@ Containers built by a PR and stored on GitHub Container Registry can be tested l 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 --password-stdin` - - 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 + - Run the following command in a terminal: + ```shell + docker login ghcr.io + ``` + you will be prompted for a username (your particular.net email) and a password (the token) + - 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`.