Compare commits
16 Commits
v1.0.1
...
feat/cr-up
| Author | SHA1 | Date | |
|---|---|---|---|
| 5607a33976 | |||
| ee44a7bfbe | |||
|
|
8bdd2cbf7b | ||
|
|
9c4c15d722 | ||
|
|
884e7b717f | ||
| e4a8514405 | |||
| 7b4ed7f7bb | |||
|
|
344d38c071 | ||
| 529f26bad9 | |||
| d41cb341b4 | |||
| 63457723cc | |||
| 402ea389ee | |||
| 58003db568 | |||
|
|
8ca7ff362d | ||
| 8ba5ad3b43 | |||
| e99caf6145 |
10
.common-repo-upstream.yaml
Normal file
10
.common-repo-upstream.yaml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Consumer config: inherit shared dev tooling from cr-upstream-repo
|
||||||
|
- repo:
|
||||||
|
url: https://github.com/common-repo/cr-upstream-repo
|
||||||
|
ref: v1
|
||||||
|
|
||||||
|
# Override upstream template vars for christmas-island
|
||||||
|
- template-vars:
|
||||||
|
GH_APP_ID_SECRET: CHRISTMAS_ISLAND_APP_ID
|
||||||
|
GH_APP_KEY_SECRET: CHRISTMAS_ISLAND_PRIVATE_KEY
|
||||||
|
GH_APP_OWNER: christmas-island
|
||||||
13
.common-repo.yaml
Normal file
13
.common-repo.yaml
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Source-level config: only expose src/ contents, renamed to root.
|
||||||
|
- include:
|
||||||
|
- "src/**"
|
||||||
|
- "src/.*"
|
||||||
|
- "src/.*/**"
|
||||||
|
- template:
|
||||||
|
- "src/.github/workflows/release.yaml"
|
||||||
|
- template-vars:
|
||||||
|
GH_APP_ID_VAR: CHRISTMAS_ISLAND_APP_ID
|
||||||
|
GH_APP_KEY_SECRET: CHRISTMAS_ISLAND_PRIVATE_KEY
|
||||||
|
GH_APP_OWNER: christmas-island
|
||||||
|
- rename:
|
||||||
|
- "^src/(.*)$": "$1"
|
||||||
62
.github/workflows/ci.yaml
vendored
62
.github/workflows/ci.yaml
vendored
@@ -1,44 +1,38 @@
|
|||||||
name: CI
|
name: CI
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_call:
|
|
||||||
pull_request:
|
pull_request:
|
||||||
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
workflow_call:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
sync-check:
|
lint:
|
||||||
name: Verify src/ sync
|
name: Lint
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
- uses: actions/checkout@v4
|
||||||
- name: Check top-level files match src/
|
|
||||||
run: |
|
- uses: actions/setup-python@v5
|
||||||
# Verify distributed files in src/ match the repo's own copies
|
with:
|
||||||
status=0
|
python-version: "3.x"
|
||||||
for file in .releaserc.yaml commitlint.config.js; do
|
|
||||||
if ! diff -q "$file" "src/$file" > /dev/null 2>&1; then
|
- uses: pre-commit/action@v3.0.1
|
||||||
echo "❌ $file differs from src/$file"
|
|
||||||
diff --color "$file" "src/$file" || true
|
test:
|
||||||
status=1
|
name: Test
|
||||||
else
|
runs-on: ubuntu-latest
|
||||||
echo "✅ $file matches src/$file"
|
steps:
|
||||||
fi
|
- uses: actions/checkout@v4
|
||||||
done
|
|
||||||
for file in .github/workflows/commitlint.yml .github/workflows/release.yaml; do
|
- uses: common-repo/setup-common-repo@v1
|
||||||
if ! diff -q "$file" "src/$file" > /dev/null 2>&1; then
|
|
||||||
echo "❌ $file differs from src/$file"
|
- name: Validate configuration
|
||||||
diff --color "$file" "src/$file" || true
|
run: common-repo validate
|
||||||
status=1
|
|
||||||
else
|
- name: Dry-run apply
|
||||||
echo "✅ $file matches src/$file"
|
run: common-repo apply --dry-run
|
||||||
fi
|
|
||||||
done
|
|
||||||
if [ $status -ne 0 ]; then
|
|
||||||
echo ""
|
|
||||||
echo "Top-level files and src/ are out of sync."
|
|
||||||
echo "Copy changes to both locations, or run: cp .releaserc.yaml commitlint.config.js src/ && cp .github/workflows/commitlint.yml .github/workflows/release.yaml src/.github/workflows/"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo ""
|
|
||||||
echo "All distributed files in sync ✅"
|
|
||||||
|
|||||||
5
.github/workflows/commitlint.yml
vendored
5
.github/workflows/commitlint.yml
vendored
@@ -14,7 +14,8 @@ jobs:
|
|||||||
name: Lint Commits
|
name: Lint Commits
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- uses: wagoid/commitlint-github-action@b948419dd99f3fd78a6548c61b7286b4ffe7cb3d # v6
|
|
||||||
|
- uses: wagoid/commitlint-github-action@v6
|
||||||
|
|||||||
25
.github/workflows/common-repo-check.yaml
vendored
Normal file
25
.github/workflows/common-repo-check.yaml
vendored
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
name: common-repo check
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
# Run daily at 08:00 UTC
|
||||||
|
- cron: "0 8 * * *"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
name: Check for upstream updates
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: common-repo/setup-common-repo@v1
|
||||||
|
|
||||||
|
- name: Check for updates
|
||||||
|
run: common-repo check --updates --config .common-repo-upstream.yaml
|
||||||
|
|
||||||
|
- name: Show diff
|
||||||
|
run: |
|
||||||
|
common-repo diff --config .common-repo-upstream.yaml --summary || true
|
||||||
|
echo "---"
|
||||||
|
common-repo diff --config .common-repo-upstream.yaml || true
|
||||||
11
.github/workflows/release.yaml
vendored
11
.github/workflows/release.yaml
vendored
@@ -30,21 +30,24 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Generate app token
|
- name: Generate app token
|
||||||
id: app-token
|
id: app-token
|
||||||
uses: actions/create-github-app-token@v1
|
uses: actions/create-github-app-token@v2
|
||||||
with:
|
with:
|
||||||
app-id: ${{ vars.CHRISTMAS_ISLAND_APP_ID }}
|
app-id: ${{ secrets.CHRISTMAS_ISLAND_APP_ID }}
|
||||||
private-key: ${{ secrets.CHRISTMAS_ISLAND_PRIVATE_KEY }}
|
private-key: ${{ secrets.CHRISTMAS_ISLAND_PRIVATE_KEY }}
|
||||||
owner: christmas-island
|
owner: christmas-island
|
||||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
|
||||||
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ steps.app-token.outputs.token }}
|
token: ${{ steps.app-token.outputs.token }}
|
||||||
persist-credentials: true
|
persist-credentials: true
|
||||||
- uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
|
|
||||||
|
- uses: actions/setup-node@v5
|
||||||
with:
|
with:
|
||||||
cache: npm
|
cache: npm
|
||||||
cache-dependency-path: ".releaserc.yaml"
|
cache-dependency-path: ".releaserc.yaml"
|
||||||
node-version: lts/*
|
node-version: lts/*
|
||||||
|
|
||||||
- name: Semantic Release
|
- name: Semantic Release
|
||||||
id: release
|
id: release
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
10
.pre-commit-config.yaml
Normal file
10
.pre-commit-config.yaml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
repos:
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v5.0.0
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: check-yaml
|
||||||
|
args: [--allow-multiple-documents]
|
||||||
|
- id: check-merge-conflict
|
||||||
|
- id: check-added-large-files
|
||||||
37
CHANGELOG.md
37
CHANGELOG.md
@@ -1,3 +1,40 @@
|
|||||||
|
## [1.3.0](https://github.com/christmas-island/cr-semantic-release/compare/v1.2.1...v1.3.0) (2026-03-15)
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* restore template vars for GitHub App customization ([#1](https://github.com/christmas-island/cr-semantic-release/issues/1)) ([9c4c15d](https://github.com/christmas-island/cr-semantic-release/commit/9c4c15d722cee528df2987faf29d8d6380da79ff))
|
||||||
|
|
||||||
|
## [1.2.1](https://github.com/christmas-island/cr-semantic-release/compare/v1.2.0...v1.2.1) (2026-03-15)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* revert template vars — GHA ${{ }} collides with ${} template syntax ([e4a8514](https://github.com/christmas-island/cr-semantic-release/commit/e4a8514405acb48c8dcd5be8df63fa8c67f57384)), closes [common-repo/common-repo#TBD](https://github.com/common-repo/common-repo/issues/TBD)
|
||||||
|
|
||||||
|
## [1.2.0](https://github.com/christmas-island/cr-semantic-release/compare/v1.1.0...v1.2.0) (2026-03-15)
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
* clean up README now that source filtering works on >=0.28.0 ([58003db](https://github.com/christmas-island/cr-semantic-release/commit/58003db568089843a5727a896cbb7b250e0f32ba))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* templatize GitHub App vars in release workflow ([402ea38](https://github.com/christmas-island/cr-semantic-release/commit/402ea389ee69ad21a40ad1a7d5d144324672fc72))
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* template glob should use post-rename path ([6345772](https://github.com/christmas-island/cr-semantic-release/commit/63457723cc0c26fbb1d17c5cf333b68f01ff991f))
|
||||||
|
* template mark must use pre-rename path, move before rename ([d41cb34](https://github.com/christmas-island/cr-semantic-release/commit/d41cb341b463f24c6fe3891af16fb7354f92a956))
|
||||||
|
|
||||||
|
## [1.1.0](https://github.com/christmas-island/cr-semantic-release/compare/v1.0.1...v1.1.0) (2026-03-15)
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
* update usage for common-repo 0.27.0 workaround ([e99caf6](https://github.com/christmas-island/cr-semantic-release/commit/e99caf614571bb35b4a95c44dcd7f94011074bac)), closes [common-repo/common-repo#229](https://github.com/common-repo/common-repo/issues/229) [#230](https://github.com/christmas-island/cr-semantic-release/issues/230)
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* restore source-declared filtering (requires common-repo >=0.28.0) ([8ba5ad3](https://github.com/christmas-island/cr-semantic-release/commit/8ba5ad3b433fd5edbd13c8c9452f77ea914869bd))
|
||||||
|
|
||||||
## [1.0.1](https://github.com/christmas-island/cr-semantic-release/compare/v1.0.0...v1.0.1) (2026-03-15)
|
## [1.0.1](https://github.com/christmas-island/cr-semantic-release/compare/v1.0.0...v1.0.1) (2026-03-15)
|
||||||
|
|
||||||
### Miscellaneous
|
### Miscellaneous
|
||||||
|
|||||||
59
README.md
59
README.md
@@ -15,28 +15,19 @@ Files distributed from `src/`:
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Add to a new repo
|
> **Requires common-repo ≥ 0.28.4** for source-declared filtering and template variable overrides.
|
||||||
|
|
||||||
```bash
|
|
||||||
cr init https://github.com/christmas-island/cr-semantic-release
|
|
||||||
```
|
|
||||||
|
|
||||||
### Add to an existing `.common-repo.yaml`
|
### Add to an existing `.common-repo.yaml`
|
||||||
|
|
||||||
```bash
|
|
||||||
cr add https://github.com/christmas-island/cr-semantic-release
|
|
||||||
```
|
|
||||||
|
|
||||||
Or manually:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# .common-repo.yaml
|
# .common-repo.yaml
|
||||||
- repo:
|
- repo:
|
||||||
url: https://github.com/christmas-island/cr-semantic-release
|
url: https://github.com/christmas-island/cr-semantic-release
|
||||||
ref: v1.0.0
|
ref: v1.1.0
|
||||||
path: src/
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
That's it. The source repo's `.common-repo.yaml` handles scoping to `src/` and stripping the prefix.
|
||||||
|
|
||||||
### Apply
|
### Apply
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -48,6 +39,7 @@ cr apply # apply
|
|||||||
|
|
||||||
```
|
```
|
||||||
cr-semantic-release/
|
cr-semantic-release/
|
||||||
|
├── .common-repo.yaml ← source-declared filtering (include src/, rename to root)
|
||||||
├── .github/workflows/ ← this repo's own CI (dogfooding)
|
├── .github/workflows/ ← this repo's own CI (dogfooding)
|
||||||
│ ├── ci.yaml ← sync check: top-level == src/
|
│ ├── ci.yaml ← sync check: top-level == src/
|
||||||
│ ├── commitlint.yml ← commit linting for this repo
|
│ ├── commitlint.yml ← commit linting for this repo
|
||||||
@@ -56,7 +48,7 @@ cr-semantic-release/
|
|||||||
├── commitlint.config.js ← this repo's own commitlint
|
├── commitlint.config.js ← this repo's own commitlint
|
||||||
├── README.md
|
├── README.md
|
||||||
├── LICENSE
|
├── LICENSE
|
||||||
└── src/ ← distributed to consumers via path: src/
|
└── src/ ← distributed to consumers
|
||||||
├── .github/workflows/
|
├── .github/workflows/
|
||||||
│ ├── commitlint.yml
|
│ ├── commitlint.yml
|
||||||
│ └── release.yaml
|
│ └── release.yaml
|
||||||
@@ -64,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
|
||||||
@@ -92,10 +101,11 @@ If you only want a subset:
|
|||||||
```yaml
|
```yaml
|
||||||
- repo:
|
- repo:
|
||||||
url: https://github.com/christmas-island/cr-semantic-release
|
url: https://github.com/christmas-island/cr-semantic-release
|
||||||
ref: v1.0.0
|
ref: v1.1.0
|
||||||
path: src/
|
|
||||||
with:
|
with:
|
||||||
- exclude: [".github/workflows/commitlint.yml"]
|
- include: ["src/.releaserc.yaml", "src/commitlint.config.js"]
|
||||||
|
- rename:
|
||||||
|
- "^src/(.*)$": "$1"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Overriding `.releaserc.yaml`
|
### Overriding `.releaserc.yaml`
|
||||||
@@ -105,8 +115,7 @@ Use common-repo's YAML merge operator to patch specific fields:
|
|||||||
```yaml
|
```yaml
|
||||||
- repo:
|
- repo:
|
||||||
url: https://github.com/christmas-island/cr-semantic-release
|
url: https://github.com/christmas-island/cr-semantic-release
|
||||||
ref: v1.0.0
|
ref: v1.1.0
|
||||||
path: src/
|
|
||||||
- yaml:
|
- yaml:
|
||||||
source: my-releaserc-overrides.yaml
|
source: my-releaserc-overrides.yaml
|
||||||
dest: .releaserc.yaml
|
dest: .releaserc.yaml
|
||||||
|
|||||||
2
src/.github/workflows/commitlint.yml
vendored
2
src/.github/workflows/commitlint.yml
vendored
@@ -17,4 +17,4 @@ jobs:
|
|||||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- uses: wagoid/commitlint-github-action@b948419dd99f3fd78a6548c61b7286b4ffe7cb3d # v6
|
- uses: wagoid/commitlint-github-action@b948419dd99f3fd78a6548d48f94e3df7f6bf3ed # v6
|
||||||
|
|||||||
6
src/.github/workflows/release.yaml
vendored
6
src/.github/workflows/release.yaml
vendored
@@ -32,9 +32,9 @@ jobs:
|
|||||||
id: app-token
|
id: app-token
|
||||||
uses: actions/create-github-app-token@v1
|
uses: actions/create-github-app-token@v1
|
||||||
with:
|
with:
|
||||||
app-id: ${{ vars.CHRISTMAS_ISLAND_APP_ID }}
|
app-id: ${{ vars.${GH_APP_ID_VAR:-CHRISTMAS_ISLAND_APP_ID} }}
|
||||||
private-key: ${{ secrets.CHRISTMAS_ISLAND_PRIVATE_KEY }}
|
private-key: ${{ secrets.${GH_APP_KEY_SECRET:-CHRISTMAS_ISLAND_PRIVATE_KEY} }}
|
||||||
owner: christmas-island
|
owner: ${GH_APP_OWNER:-christmas-island}
|
||||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|||||||
Reference in New Issue
Block a user