Skip to content

Correct Build Installers artifact-upload documentation#31

Merged
eimexdev merged 2 commits into
mainfrom
t3code/wayfinder-issue-thirteen
Jul 25, 2026
Merged

Correct Build Installers artifact-upload documentation#31
eimexdev merged 2 commits into
mainfrom
t3code/wayfinder-issue-thirteen

Conversation

@eimexdev

@eimexdev eimexdev commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • document that push and pull-request installer builds do not upload artifacts
  • distinguish temporary manual-build artifacts from durable GitHub Release assets
  • update the release checklist to smoke-test the exact assets from a draft GitHub Release
  • remove the obsolete Ko-fi publishing path from the release checklist

Verification

  • git diff --check
  • python3 -m compileall openbeat scripts tests
  • python3 -m unittest discover -s tests -v (8 tests pass in an isolated environment with project dependencies)

Resolves #13

Summary by CodeRabbit

  • Documentation
    • Clarified automatic and manual installer build workflows, including artifact availability and retention.
    • Documented how releases use installer artifacts and attach them to GitHub Releases.
    • Updated the release checklist with draft-release testing, installer verification, and publishing steps.
    • Added guidance for distinguishing temporary test installers from durable public release downloads.
    • Revised launch announcement instructions to reference the published release and source repository.

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@eimexdev, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 58 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: 0e0c5e83-0c26-41cc-904e-a472f5e71924

📥 Commits

Reviewing files that changed from the base of the PR and between 74e44d9 and 9e6515f.

📒 Files selected for processing (1)
  • docs/release-checklist.md
📝 Walkthrough

Walkthrough

Documentation updates clarify installer workflow triggers and artifact retention, and revise the release checklist to use draft GitHub Releases for installer verification, publication, source links, and launch announcements.

Changes

Release documentation

Layer / File(s) Summary
Workflow behavior and artifact handling
docs/development.md
Documents automatic test-only installer builds, manual artifact-producing builds, and the manual Release workflow’s use of those artifacts.
Draft release checklist
docs/release-checklist.md
Updates preflight, installer verification, draft release publication, repository visibility, landing-page links, and announcement sequencing.

Estimated code review effort: 1 (Trivial) | ~5 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

…e-thirteen

# Conflicts:
#	docs/release-checklist.md

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 74e44d99f4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/release-checklist.md Outdated
## Site And Announcement

- Update every public download link to the latest GitHub Release.
- Update the landing page download link to the GitHub Release.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Update the repository download instructions too

When this revised checklist switches distribution to GitHub Releases, updating only the external landing page leaves the repository's user-facing instructions contradictory: docs/install.md:7-10 and README.md:19 still direct users to Ko-fi. A release following this checklist would therefore continue sending users who arrive through the repository to the old distribution channel; include those files in the required download-link updates.

Useful? React with 👍 / 👎.

@eimexdev
eimexdev merged commit 84ada66 into main Jul 25, 2026
4 checks passed
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.

Correct Build Installers artifact-upload documentation

1 participant