christmas-island/cr-semantic-release
5
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 5 Wiki Activity

docs: document template-vars consumer overrides for GitHub App

Browse Source 
Update README:
- Bump minimum common-repo version to 0.28.4
- Add 'Using a different GitHub App' section with override example
- Note release.yaml sync exception in repo structure
This commit is contained in:
Jake Alheid
2026-03-15 04:19:06 -07:00
parent e862130db5
commit 3ecfe2176c
1 changed files with 24 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -15,7 +15,7 @@ Files distributed from `src/`:
## Usage ## Usage
> **Requires common-repo ≥ 0.28.0** for source-declared filtering. > **Requires common-repo ≥ 0.28.4** for source-declared filtering and template variable overrides.
### Add to an existing `.common-repo.yaml` ### Add to an existing `.common-repo.yaml`
@@ -56,19 +56,36 @@ cr-semantic-release/
└── commitlint.config.js └── commitlint.config.js
``` ```
The top-level files and `src/` files are identical — the repo eats its own dog food. CI enforces they stay in sync. The top-level files and `src/` files are identical — the repo eats its own dog food. CI enforces they stay in sync (except `release.yaml`, which uses template variables in `src/` and hardcoded defaults at the top level).
## Prerequisites ## Prerequisites
The release workflow expects the following GitHub org-level vars and secrets: By default, the release workflow uses these GitHub org-level vars and secrets:
| Name | Type | Purpose | | Name | Type | Default | Purpose |
|---|---|---| |---|---|---|---|
| `CHRISTMAS_ISLAND_APP_ID` | Variable | GitHub App ID for generating tokens | | `CHRISTMAS_ISLAND_APP_ID` | Variable | — | GitHub App ID for generating tokens |
| `CHRISTMAS_ISLAND_PRIVATE_KEY` | Secret | GitHub App private key | | `CHRISTMAS_ISLAND_PRIVATE_KEY` | Secret | — | GitHub App private key |
These are used by `actions/create-github-app-token` to generate a token with write permissions for creating releases and pushing tags/changelogs. These are used by `actions/create-github-app-token` to generate a token with write permissions for creating releases and pushing tags/changelogs.
### Using a different GitHub App
Override the template variables in your consumer config to use your own app credentials:
```yaml
- repo:
url: https://github.com/christmas-island/cr-semantic-release
ref: v2.0.0
with:
- template-vars:
GH_APP_ID_VAR: MY_APP_ID # GitHub vars name
GH_APP_KEY_SECRET: MY_APP_KEY # GitHub secrets name
GH_APP_OWNER: my-org # App installation owner
```
This renders the workflow with `${{ vars.MY_APP_ID }}`, `${{ secrets.MY_APP_KEY }}`, and `owner: my-org`.
## Customization ## Customization
### Release workflow ### Release workflow