Skip to content

docs: correct contributing Codespaces usage #40

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
rcwbr merged 1 commit into from
Sep 28, 2025
Merged

docs: correct contributing Codespaces usage #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 3 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ population by CI pipeline.
- [Codespace prebuilds configuration](#codespace-prebuilds-configuration)
- [Contributing](#contributing)
- [devcontainer](#devcontainer)
- [devcontainer basic usage](#devcontainer-basic-usage)
- [devcontainer Codespaces usage](#devcontainer-codespaces-usage)
- [devcontainer pre-commit usage](#devcontainer-pre-commit-usage)
- [CI/CD](#cicd)
Expand Down Expand Up @@ -323,16 +322,11 @@ This repo contains a [devcontainer definition](https://containers.dev/) in the `
folder. It leverages its own devcontainer cache build tool and layers
[defined in the dockerfile-partials repo](https://github.com/rcwbr/dockerfile-partials).

#### devcontainer basic usage<a name="devcontainer-basic-usage"></a>

The devcontainer cache build tool requires authentication to the GitHub package registry, as a token
stored as `DOCKERFILE_PARTIALS_DEVCONTAINER_INITIALIZE` (see
[instructions](#initialize-script-github-container-registry-setup)).

#### devcontainer Codespaces usage<a name="devcontainer-codespaces-usage"></a>

For use with Codespaces, the `DOCKERFILE_PARTIALS_DEVCONTAINER_INITIALIZE` token (see
[devcontainer basic usage](#devcontainer-basic-usage)) must be stored as a Codespaces secret (see
For use with Codespaces, the `DEVCONTAINER_CACHE_BUILD_CONTAINER_REGISTRY_SERVER`,
`DEVCONTAINER_CACHE_BUILD_CONTAINER_REGISTRY_USER`, and
`DEVCONTAINER_CACHE_BUILD_CONTAINER_REGISTRY_PASSWORD` variables stored as Codespaces secrets (see
[instructions](#initialize-script-github-container-registry-setup)), as must values for `USER`, and
`UID` (see
[useradd Codespaces usage](https://github.com/rcwbr/dockerfile-partials#useradd-codespaces-usage)).
Expand Down