Skip to content

Reflect the pre-merge Dokka CI gate in guidelines and skills#18

Merged
alexander-yevsyukov merged 1 commit into
masterfrom
claude/magical-cerf-hp5u51
Jun 15, 2026
Merged

Reflect the pre-merge Dokka CI gate in guidelines and skills#18
alexander-yevsyukov merged 1 commit into
masterfrom
claude/magical-cerf-hp5u51

Conversation

@alexander-yevsyukov

Copy link
Copy Markdown
Contributor

Context

Companion to SpineEventEngine/config#689, which makes the PR build run dokkaGenerate (config's distributed build-on-ubuntu.yml). Documentation warnings are now caught during PR review, not only in the post-merge publish job.

Change

Several guidelines and skills stated that an unresolved KDoc/Javadoc link fails "only in the publish CI job". That is no longer accurate once the PR build runs Dokka, so update them to describe CI's Dokka run (the PR build) as the gate, with the publish job as a backstop:

  • guidelines/running-builds.md
  • guidelines/documentation.md
  • guidelines/kdoc.md
  • guidelines/javadoc.md
  • skills/pre-pr/SKILL.md (frontmatter + body)
  • skills/review-docs/SKILL.md
  • claude/commands/run-build.md

The guidance to run ./gradlew build dokkaGenerate locally (and in pre-pr) is unchanged — it still gives the earliest feedback, before pushing.

Notes

These are text-only edits to floating org-wide docs; no behaviour change here. The behaviour change lives in the config PR.

https://claude.ai/code/session_01QcJcahKjYEXfaVrVrYo5sj


Generated by Claude Code

Documentation warnings are now caught by `dokkaGenerate` in the PR build
(config's `build-on-ubuntu.yml`), not only in the post-merge publish job.
Update the guidelines (`running-builds`, `documentation`, `kdoc`,
`javadoc`), the `pre-pr` and `review-docs` skills, and the `run-build`
command so they no longer state that Dokka runs "only in the publish CI
job". The publish job is now described as a backstop.

https://claude.ai/code/session_01QcJcahKjYEXfaVrVrYo5sj
@alexander-yevsyukov alexander-yevsyukov self-assigned this Jun 15, 2026
@alexander-yevsyukov alexander-yevsyukov marked this pull request as ready for review June 15, 2026 12:34
Copilot AI review requested due to automatic review settings June 15, 2026 12:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates org-wide guidelines and agent skills to reflect that Dokka (dokkaGenerate) is now enforced during the PR build CI (with the publish job remaining as a backstop), instead of only being enforced during the publish pipeline.

Changes:

  • Reworded guidance across documentation guidelines to state that unresolved KDoc/Javadoc links fail CI’s Dokka run (PR build), not just the publish job.
  • Updated pre-pr and review-docs skill text to match the new CI gate wording while keeping the local ./gradlew build dokkaGenerate recommendation unchanged.
  • Adjusted the run-build command guidance to align with the pre-merge Dokka CI gate.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
skills/review-docs/SKILL.md Updates reviewer checklist wording to describe PR-build Dokka as the primary gate, publish as backstop.
skills/pre-pr/SKILL.md Updates pre-PR checklist description and Dokka rationale to reflect CI Dokka run (PR build).
guidelines/running-builds.md Aligns build-running guidance with the new PR-build Dokka CI enforcement.
guidelines/kdoc.md Updates KDoc verification note to state failures occur in CI’s Dokka run.
guidelines/javadoc.md Updates Javadoc verification note to state failures occur in CI’s Dokka run.
guidelines/documentation.md Updates the buildSrc/config unresolved-link warning text to reference PR-build Dokka gate + publish backstop.
claude/commands/run-build.md Updates build-command decision guidance to reference CI Dokka run rather than publish-only failures.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@alexander-yevsyukov alexander-yevsyukov merged commit dc49826 into master Jun 15, 2026
1 check passed
@alexander-yevsyukov alexander-yevsyukov deleted the claude/magical-cerf-hp5u51 branch June 15, 2026 22:38
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.

4 participants