From ad712058aadc103ca2da522a615a64077e7aa429 Mon Sep 17 00:00:00 2001
From: Eric Weber <github@weber.lol>
Date: Fri, 8 Nov 2024 07:21:42 -0800
Subject: [PATCH] docs: ci/cd and settings info

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 19e9cb4..9e41aee 100644
--- a/README.md
+++ b/README.md
@@ -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.