Repository navigation
ci: add docs impact template and open docs issues on release - #18
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
|
- PR template with a Docs impact section and a reminder to flag d2.config.js min/max changes for the compatibility page - document the `docs:` changeset note in AGENTS.md and .changeset/README.md - docs-impact job in release.yml runs scripts/docs-impact.mjs, which reads the `docs:` notes from the new CHANGELOG.md section, diffs the DHIS2 version range against the previous tag, opens a Docs impact issue in the docs repo and sends app-released / app-compat-changed dispatches; skips with a warning when DOCS_REPO_TOKEN is missing Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LZTKXxVkBdpd1uHuJWerFT
nnkogift
force-pushed
the
nnkogift/nnk-198-release-notes-page-and-docs-impact-process-for-app-releases
branch
from
October 26, 2026 04:08
8e6525f to
07879de
Compare
nnkogift
merged commit Oct 26, 2026
c404555
into
nnkogift/nnk-185-update-readme-agentsmd-and-the-linear-project-description-to
1 check passed
Owner
Author
|
These changes reached Generated by Claude Code |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stack (app repo): 3 of 3. Base: NNK-185 README/AGENTS.md.
App half of NNK-198 (the release notes page is in the docs repo stack).
.github/pull_request_template.md: a "Docs impact" section (none / pages affected / screenshots change), plus a reminder to flagd2.config.jsmin/max changes and to keepSUPPORTED_DHIS2_RANGEinsrc/shared/constants/links.tsin sync.docs:changeset notes: documented in AGENTS.md (Releases) and.changeset/README.md. Put a line starting withdocs:in its own paragraph after the summary; the changelog copies it intoCHANGELOG.md.release.yml: a separatedocs-impactjob runs after a successful publish, so a docs-side failure can't block the release. It runsscripts/docs-impact.mjs, which:docs:lines from the new version'sCHANGELOG.mdsectionminDHIS2Version/maxDHIS2Versionwith the previousv*tagrepository_dispatchapp-releasedto the docs repo, plusapp-compat-changedwhen the range movedDocs impact: program-rules-playground vXissue per version when there are notes or a range change::warning::and exits 0;--dry-runprints theghcalls instead of running themNeeds before it does anything: a
DOCS_REPO_TOKENrepo secret. That's a fine-grained PAT onnnkogift/program-rules-playground-docswith Issues read/write and Contents read. The docs repo listens for the dispatches in the screenshot workflow (NNK-190 PR).Checks:
pnpm lint,pnpm typecheck,pnpm testpass; release.yml parses; script tested in dry-run and no-token modes.Generated by Claude Code