docs(release): Make+Nix release flow with gh publish by rtacconi · Pull Request #16 · rtacconi/kcore

rtacconi · 2026-04-29T15:56:47Z

Add scripts/release.sh (build ISO and kcore-kctl, dist tarball/checksums, gh release). Add Makefile release-* targets; fix ISO discovery for Nix output filename. Document process in docs/release.md; template RELEASE_NOTES; link from README.

Summary by CodeRabbit

New Features
- Added automated release workflow for building and publishing versioned artifacts via make release command with integrated GitHub Release support.
Documentation
- Added comprehensive release guide with step-by-step instructions for managing releases.
- Added standardized release notes template for consistent release documentation.
Chores
- Updated build configuration and ignore patterns to support the release process.

Add scripts/release.sh (build ISO and kcore-kctl, dist tarball/checksums, gh release). Add Makefile release-* targets; fix ISO discovery for Nix output filename. Document process in docs/release.md; template RELEASE_NOTES; link from README.

coderabbitai · 2026-04-29T15:57:26Z

Warning

Rate limit exceeded

@rtacconi has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes and 31 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fb91b311-41df-4b91-851c-5da89aba11bd

📥 Commits

Reviewing files that changed from the base of the PR and between 1505d4e and b5d4328.

📒 Files selected for processing (4)

.github/workflows/formal-checks.yml
docs/file-structure.md
docs/release.md
scripts/release.sh

📝 Walkthrough

Walkthrough

This pull request introduces a comprehensive release workflow infrastructure for the kcore project. Changes include Makefile targets delegating to a new release orchestration script, release documentation with step-by-step instructions, a template for release notes, configuration updates to gitignore and documentation indices, and a Bash script that handles building, packaging, and publishing release artifacts.

Changes

Cohort / File(s)	Summary
Release Orchestration `Makefile`, `scripts/release.sh`	Added `release-build`, `release-dist`, `release-publish`, and `release` phony targets to Makefile that delegate to a new Bash orchestration script. The script reads VERSION, executes Nix builds, packages distribution artifacts (tarball and ISO), generates SHA256SUMS, and publishes releases to GitHub via the `gh` CLI.
Release Documentation `docs/release.md`, `RELEASE_NOTES.template.md`	Introduced comprehensive release workflow documentation covering prerequisites, versioning policy, step-by-step release procedures (version bump, tag, build, package, publish), and troubleshooting notes. Added a template for standardized release notes with sections for highlights and installation instructions.
Documentation Index Updates `docs/README.md`, `docs/file-structure.md`, `README.md`	Updated documentation indices and main README to reference the new release documentation and make release-related files discoverable within the repository structure.
Configuration `.gitignore`	Extended gitignore patterns to exclude release build artifacts (`/result-kctl`, `/dist`) and generated release notes file (`/RELEASE_NOTES.md`).

Sequence Diagram

sequenceDiagram
    actor User
    participant Make as Make<br/>(release target)
    participant ReleaseScript as scripts/release.sh
    participant Nix as Nix Build
    participant FileSystem as Distribution<br/>Artifacts
    participant GitHub as GitHub API<br/>(gh CLI)

    User->>Make: make release
    Make->>ReleaseScript: release.sh build
    ReleaseScript->>Nix: nix build (iso + kctl)
    Nix-->>ReleaseScript: result-iso, result-kctl
    ReleaseScript->>Make: ✓ build complete

    User->>Make: make release-dist
    Make->>ReleaseScript: release.sh dist
    ReleaseScript->>FileSystem: create dist/
    ReleaseScript->>FileSystem: package kcore-kctl.tar.gz
    ReleaseScript->>FileSystem: copy versioned ISO
    ReleaseScript->>FileSystem: write SHA256SUMS
    ReleaseScript-->>Make: ✓ artifacts ready

    User->>Make: make release-publish
    Make->>ReleaseScript: release.sh publish
    ReleaseScript->>GitHub: gh release create --verify-tag
    ReleaseScript->>GitHub: upload tarball, ISO, checksums
    GitHub-->>ReleaseScript: Release published
    ReleaseScript-->>Make: ✓ published

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰✨ A release workflow hops to life,
From Nix builds through GitHub's door,
Version bumps and checksums bright,
The scripts now orchestrate the flight—
Publish artifacts with delight! 🎉

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: introducing a documented release workflow using Make, Nix, and GitHub (gh). It is concise, specific, and clearly conveys the primary purpose of the changeset.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/release-make-nix-github

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

_{Review rate limit: 0/1 reviews remaining, refill in 15 minutes and 31 seconds.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (1)

docs/file-structure.md (1)
253-253: Keep the top project tree in sync with this new catalog coverage.

You added these files in the full catalog, but the earlier “Project tree” block still omits them. Updating both sections together avoids conflicting documentation.

Also applies to: 272-272
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/file-structure.md` at line 253, The top "Project tree" block is missing
entries that were added to the full catalog (notably scripts/release.sh); update
the Project tree section to include the same new files and brief descriptions so
both sections stay in sync—locate the "Project tree" block in file-structure.md,
add an entry for scripts/release.sh (and any other files present in the full
catalog but omitted), and ensure the wording matches the catalog descriptions.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/release.md`:
- Around line 50-52: The bullet for `dist/kcoreos-$(VERSION)-x86_64-linux.iso`
is indented differently and triggers markdownlint MD005; edit the release.md
bullet list so that the line containing
`dist/kcoreos-$(VERSION)-x86_64-linux.iso` has the same leading indentation as
the sibling bullets (matching `dist/kcore-kctl-$(VERSION)-linux-x86_64.tar.gz`
and `dist/SHA256SUMS`) to make all three list items consistent.

In `@scripts/release.sh`:
- Around line 65-80: The script calls gh directly (see the gh release create
invocation and the cmd_publish wrapper) which violates the scripts/ guideline;
change the release creation to invoke gh via nix develop --command so gh runs
inside the Nix dev shell (e.g., run nix develop --command "gh release create
...") or use a small helper that prefixes commands with nix develop --command
when running dev tools; update the gh release create invocation (and any other
direct gh calls) to use that nix develop wrapper so tooling runs under the
repository's Nix environment.

---

Nitpick comments:
In `@docs/file-structure.md`:
- Line 253: The top "Project tree" block is missing entries that were added to
the full catalog (notably scripts/release.sh); update the Project tree section
to include the same new files and brief descriptions so both sections stay in
sync—locate the "Project tree" block in file-structure.md, add an entry for
scripts/release.sh (and any other files present in the full catalog but
omitted), and ensure the wording matches the catalog descriptions.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b5d4b8dd-5376-4b78-bac0-d6347139f792

📥 Commits

Reviewing files that changed from the base of the PR and between b2dbc70 and 1505d4e.

📒 Files selected for processing (8)

.gitignore
Makefile
README.md
RELEASE_NOTES.template.md
docs/README.md
docs/file-structure.md
docs/release.md
scripts/release.sh

…op, file tree)

coderabbitai Bot reviewed Apr 29, 2026

View reviewed changes

Comment thread docs/release.md

Comment thread scripts/release.sh Outdated

rtacconi added 3 commits April 29, 2026 17:04

fix(release): address CodeRabbit PR16 (markdownlint, gh via nix devel…

f4d51d8

…op, file tree)

fix(ci): quote kani-shard job name for valid YAML

be9ff79

fix(ci): raise kani-shard timeouts (job was capped below install+proof)

b5d4328

rtacconi merged commit 6d61ae9 into main Apr 29, 2026
12 of 20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(release): Make+Nix release flow with gh publish#16

docs(release): Make+Nix release flow with gh publish#16
rtacconi merged 4 commits into
mainfrom
docs/release-make-nix-github

rtacconi commented Apr 29, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 29, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

rtacconi commented Apr 29, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

rtacconi commented Apr 29, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 29, 2026 •

edited

Loading