Skip to content

ci: take the template's fixes from its latest version - #114

Merged
gustavohrm merged 2 commits into
mainfrom
ci/template-sync
Nov 12, 2026
Merged

gustavohrm merged 2 commits into
mainfrom
ci/template-sync

Conversation

@gustavohrm

@gustavohrm gustavohrm commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

Summary

Compares Haku with codenhub/template at e7f1e72 (core and the node-pnpm profile), hunk by hunk, and takes the template's side where it is better:

  • CI concurrency: push and merge-queue runs are grouped by commit, not by branch, so a third quick push to main no longer cancels the pending second run. Pull request runs still cancel superseded ones. docs/ci.md explains the change and its cost: runs on main can now run in parallel.
  • minimumReleaseAge: docs/ci.md now says pnpm only prefers versions older than a day, since the workspace does not set the option.
  • Code guidelines: mark state as saved only after the write succeeds.
  • Security guidelines: the read itself enforces an input's size bound.
  • Documentation guidelines: a new "Document roles" section. Under it, the index drops "Start here" from the Architecture row.

Kept as Haku's: "report it privately" (Haku is public and uses private vulnerability reporting), the existing format script, and the already-filled prompts.

Fixes #111

Checks

  • The delivery gate CONTRIBUTING.md names passes, pnpm verify by default, or the skipped steps are listed here

  • Documentation affected by behavior, API, or convention changes is updated in this pull request

  • docs/architecture.md is updated if the architecture changed (not changed)

  • src/bindings.ts is regenerated (pnpm bindings) if the IPC boundary changed (not changed)

  • pnpm check:release passes if tauri/Cargo.toml features changed (not changed)

  • A new IPC command, event, capability, or permission is named in the description and tested (none added)

Security

No code changes. The security guideline's size-bound rule is tightened. A follow-up issue may cover the existing unbounded reads of the settings file and extension manifests.

🤖 Generated with Claude Code


Summary by cubic

Applies the latest codenhub/template fixes to CI and documentation, addressing #111.

  • Groups push and merge-queue CI runs by commit instead of branch, so a third push to main no longer cancels a pending run. Pull request runs still cancel superseded ones, and runs on main can now run in parallel.
  • Corrects docs/ci.md: minimumReleaseAge prefers versions older than a day but is not a hard gate, since the workspace does not set it.
  • States in the code guidelines that state is marked saved only after the write succeeds, and in the security guidelines that the read itself enforces an input's size bound.
  • Adds a "Document roles" section to the documentation guidelines, which forbids leaf documents from routing readers. Under it, docs/README.md and docs/architecture.md drop their routing lines.

Written for commit 1ca29b6. Summary will update on new commits.

View guided diff Turn on auto-fix

Summary by CodeRabbit

  • Documentation
    • Clarified guidance on dependency installation timing, CI run grouping, and handling unsaved changes and write errors.
    • Expanded documentation guidance on document roles and updated security recommendations for reading untrusted input, including enforcing size limits during the read.
    • Refreshed documentation indexes and update dates.

Compared with codenhub/template at e7f1e72, core and node-pnpm profile,
hunk by hunk. Taken: concurrency grouped by commit for push and
merge-queue runs, so a third push to main no longer cancels the pending
second; the corrected minimumReleaseAge description; the saved-state and
read-enforced size-bound rules; and the document-roles section, with the
index's "Start here" removed under it.

Fixes #111

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Explain Change →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 54 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: b11e9d0b-ff25-4043-894b-09f579f3e27f
Commits

Reviewing files that changed from the base of the PR and between 8a69a16 and 1ca29b6.

Files selected for processing: 3

  • docs/README.md
  • docs/architecture.md
  • docs/guidelines/security.md

No actionable comments were generated in the recent review.

Walkthrough

The workflow now groups pull-request runs by ref and other runs by commit SHA. CI documentation and development guidelines were updated with revised guidance on dependency installation, document roles, saved-state handling, and bounded reads.

Changes: CI behavior and guidance

Layer / File(s) Summary
Concurrency grouping and documentation
.github/workflows/ci.yml, docs/ci.md
Pull-request runs use the pull-request ref as the concurrency key. Other runs use the commit SHA. The CI documentation describes the grouping behavior.
Dependency-install guidance
docs/ci.md
The documentation clarifies pnpm's default minimumReleaseAge behavior, how explicit configuration affects installs, and how an exact-version exclusion can allow an early install.

Documentation roles

Layer / File(s) Summary
Document index and role guidance
docs/README.md, docs/guidelines/documentation.md
The index updates its Architecture and Guidelines descriptions. The documentation guideline defines guidance, agent guidance, and leaf documentation, and updates a link.

Saved-state guidance

Layer / File(s) Summary
Write and saved-state guidance
docs/guidelines/code.md
The guideline distinguishes unsaved in-memory changes from saved-state markers. It requires successful writes before marking data saved and says not to swallow write errors.

Input-size guidance

Layer / File(s) Summary
Read-time size limits
docs/guidelines/security.md
The guideline requires reads to stop and reject input at the size limit. It explains why checks only before or after reading do not enforce that bound.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix · Severity of issue fixed: Medium

Possibly related PRs

  • gustavohrm/haku#106: Adds the merge-queue trigger and the earlier concurrency configuration and documentation that this change updates.
Merge Risk: Minimal · previous review 8a69a

This change fixes CI concurrency so every push to main completes and reports, and updates documentation. No merge-blocking risk remains.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "ci: take the template's fixes from its latest version" is partially related. The changeset adopts several template changes, and the CI concurrency change (commit-based grouping for push and…
Description check Passed The description follows the template's structure. It has a What and why summary that lists the adopted changes and their reasons, and it links the fix to issue #111. It also includes the Checks sectio…
Linked Issues check Passed Issue #111 requires that every push to main completes and reports, so a third push does not cancel the pending run for the second commit. The reviewed head changes .github/workflows/ci.yml `concur…
Out of Scope Changes check Passed The concurrency change in .github/workflows/ci.yml implements #111 directly. The other changes are documentation and guideline edits: docs/ci.md (minimumReleaseAge wording and concurrency explanat…
Full details: Title check

Explanation

The title "ci: take the template's fixes from its latest version" is partially related. The changeset adopts several template changes, and the CI concurrency change (commit-based grouping for push and merge-queue runs) is the first and most prominent one. However, the title is broad and does not name the CI concurrency change or the other adopted changes (minimumReleaseAge wording, code/security/documentation guidelines). It also does not say the change is a sync with codenhub/template at a specific commit. The title is not off-topic, and it does not use a vague term like "misc updates".

Full details: Description check

Explanation

The description follows the template's structure. It has a What and why summary that lists the adopted changes and their reasons, and it links the fix to issue #111. It also includes the Checks section, with the template's items marked or annotated, and the Security section, which explains that there are no code changes. Some template items are left unexplained. The IPC-related checks are marked as not applicable, and the security section does not address the template's per-item checks for new untrusted input or new dependencies in detail. The description is still mostly complete.

Full details: Linked Issues check

Explanation

Issue #111 requires that every push to main completes and reports, so a third push does not cancel the pending run for the second commit. The reviewed head changes .github/workflows/ci.yml concurrency.group from ${{ github.workflow }}-${{ github.ref }} to ${{ github.workflow }}-${{ github.event_name == 'pull_request' &amp;&amp; github.ref || github.sha }}. Push and merge_group runs now group by commit SHA. Each push to main therefore has its own group, so a later push cannot cancel an earlier commit's pending run. cancel-in-progress remains ${{ github.event_name == 'pull_request' }}, so pull request runs still cancel superseded runs. The comment block documents the change and docs/ci.md is updated per the PR description. The requirement is a CI configuration fix, so no unit test applies. The change itself was verified by reading the workflow file at head; it was not run in GitHub Actions. Objective grouped under [#111].

Full details: Out of Scope Changes check

Explanation

The concurrency change in .github/workflows/ci.yml implements #111 directly. The other changes are documentation and guideline edits: docs/ci.md (minimumReleaseAge wording and concurrency explanation), docs/README.md (index row and document roles), docs/guidelines/code.md (saved-state rule), docs/guidelines/security.md (read-enforced size bound), and docs/guidelines/documentation.md (Document roles section). These do not relate to #111 by topic. However, the issue names a template comparison as the adoption path, and the PR states that these hunks are the adopted template changes from that comparison. No code outside the CI workflow changed. The changes are disclosed in the PR summary, so no change appears hidden or unrelated. Reviewers may still prefer that the non-CI hunks be split into a separate change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • 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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 0285df65-8fe9-4be6-8b9d-29fb4d199eb7
Commits

Reviewing files that changed from the base of the PR and between 5c8debb and 8a69a16.

Files selected for processing: 6

  • .github/workflows/ci.yml
  • docs/README.md
  • docs/ci.md
  • docs/guidelines/code.md
  • docs/guidelines/documentation.md
  • docs/guidelines/security.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 6 files

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread docs/ci.md Resolved
Comment thread docs/guidelines/documentation.md Resolved
Comment thread docs/guidelines/security.md Resolved
The document-roles rule bars leaf documents from telling the reader
when to read another one, so the index's "Start with Architecture" and
Architecture's "Read it before building" go. The size-bound rule said an
input reaching the limit is rejected; it now says an input past the
limit is, which matches the bookmark reader.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@gustavohrm
gustavohrm merged commit 8e691ca into main Nov 12, 2026
7 checks passed
@gustavohrm
gustavohrm deleted the ci/template-sync branch November 12, 2026 20:31
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.

CI concurrency can cancel a pending run on main

1 participant