Skip to content

Commit

Permalink
docs: ci/cd and settings info
Browse files Browse the repository at this point in the history
  • Loading branch information
rcwbr authored Nov 8, 2024
1 parent a1dbbce commit ad71205
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,3 +321,13 @@ The [devcontainer cache build tool](https://github.com/rcwbr/devcontainer-cache-
#### devcontainer Codespaces usage
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 [instructions](https://github.com/rcwbr/devcontainer-cache-build/tree/main?tab=readme-ov-file#initialize-script-github-container-registry-setup)), as must values for `USER`, and `UID` (see [useradd Codespaces usage](#useradd-codespaces-usage)).
### CI/CD
This repo uses the [release-it-gh-workflow](https://github.com/rcwbr/release-it-gh-workflow), with the conventional-changelog image defined at any given ref, as its automation.
### Settings
The GitHub repo settings for this repo are defined as code using the [Probot settings GitHub App](https://probot.github.io/apps/settings/). Settings values are defined in the `.github/settings.yml` file. Enabling automation of settings via this file requires installing the app.
The settings applied are as recommended in the [release-it-gh-workflow usage](https://github.com/rcwbr/release-it-gh-workflow/blob/4dea4eaf328b60f92dab1b5bd2a63daefa85404b/README.md?plain=1#L58), including tag and branch protections, GitHub App and environment authentication, and required checks.

0 comments on commit ad71205

Please sign in to comment.