Skip to content

ci: add docs impact template and open docs issues on release - #18

Merged
nnkogift merged 1 commit into
nnkogift/nnk-185-update-readme-agentsmd-and-the-linear-project-description-tofrom
nnkogift/nnk-198-release-notes-page-and-docs-impact-process-for-app-releases
Oct 26, 2026
Merged

nnkogift merged 1 commit into
nnkogift/nnk-185-update-readme-agentsmd-and-the-linear-project-description-tofrom
nnkogift/nnk-198-release-notes-page-and-docs-impact-process-for-app-releases

Conversation

@nnkogift

Copy link
Copy Markdown
Owner

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 flag d2.config.js min/max changes and to keep SUPPORTED_DHIS2_RANGE in src/shared/constants/links.ts in sync.
  • docs: changeset notes: documented in AGENTS.md (Releases) and .changeset/README.md. Put a line starting with docs: in its own paragraph after the summary; the changelog copies it into CHANGELOG.md.
  • release.yml: a separate docs-impact job runs after a successful publish, so a docs-side failure can't block the release. It runs scripts/docs-impact.mjs, which:
    • reads the docs: lines from the new version's CHANGELOG.md section
    • compares minDHIS2Version / maxDHIS2Version with the previous v* tag
    • always sends repository_dispatch app-released to the docs repo, plus app-compat-changed when the range moved
    • opens one Docs impact: program-rules-playground vX issue per version when there are notes or a range change
    • with no token, prints a ::warning:: and exits 0; --dry-run prints the gh calls instead of running them

Needs before it does anything: a DOCS_REPO_TOKEN repo secret. That's a fine-grained PAT on nnkogift/program-rules-playground-docs with 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 test pass; release.yml parses; script tested in dry-run and no-token modes.


Generated by Claude Code

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9858f0f0-5ca7-4688-b523-7292ef8885b5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

- 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
nnkogift force-pushed the nnkogift/nnk-198-release-notes-page-and-docs-impact-process-for-app-releases branch from 8e6525f to 07879de Compare October 26, 2026 04:08
@nnkogift
nnkogift merged commit c404555 into nnkogift/nnk-185-update-readme-agentsmd-and-the-linear-project-description-to Oct 26, 2026
1 check passed

Copy link
Copy Markdown
Owner Author

These changes reached alpha through #20. This PR was merged into its stacked base branch, not alpha.


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant