Skip to content

Docs: describe changelog entries in the pull request description #60

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
SandObserver merged 1 commit into from
Sep 19, 2026
Merged

Docs: describe changelog entries in the pull request description #60

Show file tree
Hide file tree
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
3 changes: 1 addition & 2 deletions src/content/docs/docs/contributing/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ CI runs `.github/actions/checks/action.yml`:
```sh
npm ci
node scripts/changelog-check.js
node scripts/changelog-fragments.js --check
node scripts/bump-cache-busting.js --check
npm run paths:check
cd api && npm test
Expand All @@ -53,7 +52,7 @@ docker build -t stackyard:ci .

CodeQL and Trivy also run. Both block on a finding.

- Do not edit `CHANGELOG.md`. Add a fragment in `changelog.d/` named `<section>-<slug>.md`.
- Do not edit `CHANGELOG.md`. List user-visible changes in the pull request description under **Changelog**, as `- ` lines below a Keep a Changelog heading such as `### Fixed`. Merging adds them to `[Unreleased]`.
- Write `?v=1` on new `/css/` and `/js/` imports. The release sets the real hash.
- A new `ui/js` module needs two entries in `tsconfig.frontend.json`: the path and its `?v=*` form.
- Run Biome through `npm run lint`. A bare `npx biome` runs an unrelated package.
4 changes: 2 additions & 2 deletions src/content/docs/docs/contributing/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: How a Stackyard version is cut, signed and published, and how the p
## Cut a release

1. Run **Release prep** in Actions with the version, such as `1.8.0`.
2. It folds `changelog.d/` into the changelog, bumps the version, pins the demo image, and opens a pull request.
2. It dates the `[Unreleased]` section, bumps the version, pins the demo image, and opens a pull request.
3. Merge it. The tag builds, scans, signs and publishes the image and the release page.
4. Merge the Community Applications pull request that follows.

Expand All @@ -16,7 +16,7 @@ If a release build fails, fix `main`, delete the tag, and push it again.

## Secrets

- `RELEASE_APP_CLIENT_ID` and `RELEASE_APP_PRIVATE_KEY`: a GitHub App with read and write on Contents and Pull requests, installed on this repository only. The built-in token cannot trigger the release workflows.
- `RELEASE_APP_CLIENT_ID` and `RELEASE_APP_PRIVATE_KEY`: a GitHub App with read and write on Contents and Pull requests, installed on this repository only. The built-in token cannot trigger the release workflows. The app is also a bypass actor on the `main` ruleset, so it can push changelog entries after each merge.
- `DOCS_DEPLOY_HOOK_URL`: a Cloudflare Pages deploy hook. It rebuilds this site after a stable release. The release still succeeds without it.

## Demo
Expand Down
Loading