ci: write release notes a downloader can act on, pointing at GitHub #489

Merged

natsukium merged 1 commit from ci/release-notes-wording into main 2026-09-26 16:26:24 +09:00

Conversation 0 Commits 1 Files changed 2 +28 -11

natsukium commented 2026-09-26 16:06:10 +09:00

Owner

Copy link

The body of each release page, which the GitHub release mirror copies unchanged, was hard to use:

• Four printf lines had no blank lines between them, so Markdown rendered them as one paragraph.
• Some wording was internal: aarch64-linux "is committed … but carries no claim", and macOS said "clear its quarantine attribute" without giving the command.
• The flake reference pointed at Forgejo, even on the GitHub page.

The assembled body is now:

• a Downloads list with one entry per archive plus Nix. Each entry says what to run. The macOS entry gives the xattr -dr com.apple.quarantine command, and the Nix entry uses nix run github:felis-terminal/felis/<tag>.
• a link to install.md at the tag, on GitHub.
• one sentence naming the three supported platforms and saying aarch64-linux is not supported.
• one sentence on what felis.proto and felis-config.schema.json are.
• the version's CHANGELOG section under ## Changes, only when it has entries (a candidate's Unreleased section is usually empty). The leading blank lines and the link-reference definitions at the end of the file are stripped.

I checked it by extracting the run: script and rendering it locally for v0.1.0 and for an rc tag. The workspace.md sentence that describes the release body is updated to match.

The body of each release page, which the GitHub release mirror copies unchanged, was hard to use: - Four printf lines had no blank lines between them, so Markdown rendered them as one paragraph. - Some wording was internal: `aarch64-linux` "is committed … but carries no claim", and macOS said "clear its quarantine attribute" without giving the command. - The flake reference pointed at Forgejo, even on the GitHub page. The assembled body is now: - a **Downloads** list with one entry per archive plus Nix. Each entry says what to run. The macOS entry gives the `xattr -dr com.apple.quarantine` command, and the Nix entry uses `nix run github:felis-terminal/felis/<tag>`. - a link to `install.md` at the tag, on GitHub. - one sentence naming the three supported platforms and saying `aarch64-linux` is not supported. - one sentence on what `felis.proto` and `felis-config.schema.json` are. - the version's CHANGELOG section under `## Changes`, only when it has entries (a candidate's Unreleased section is usually empty). The leading blank lines and the link-reference definitions at the end of the file are stripped. I checked it by extracting the `run:` script and rendering it locally for `v0.1.0` and for an rc tag. The `workspace.md` sentence that describes the release body is updated to match.

natsukium added 1 commit 2026-09-26 16:06:10 +09:00

ci: write release notes a downloader can act on, pointing at GitHub ... ab1cec3104

The release body ran four printf lines together into one Markdown
paragraph, spoke in internal terms ("committed ... but carries no
claim", "clear its quarantine attribute" with no command), and gave a
Forgejo flake reference even on the GitHub mirror, which is the
project's public face.

The body is now a Downloads list with one entry per asset plus Nix,
each saying what to run, the macOS entry giving the xattr command, the
Nix entry using the github: reference, and a link to install.md at the
tag. It explains the two schema assets, and appends the CHANGELOG
section under a Changes heading only when that section has entries,
without the link-reference definitions that trail the file.

Assisted-by: Claude Code

natsukium force-pushed ci/release-notes-wording from ab1cec3104 to 9aeed95c70 2026-09-26 16:06:22 +09:00 Compare

natsukium force-pushed ci/release-notes-wording from 9aeed95c70 to 949e900f1f 2026-09-26 16:11:49 +09:00 Compare

natsukium merged commit 78938b4f72 into main 2026-09-26 16:26:24 +09:00

natsukium deleted branch ci/release-notes-wording 2026-09-26 16:26:24 +09:00

natsukium referenced this pull request from a commit 2026-09-26 16:26:25 +09:00

ci: write release notes a downloader can act on, pointing at GitHub (#489)

Commenting is not possible because the repository is archived.

Reviewers

No reviewers

Labels

Clear labels   

priority/P0

Must be resolved before the v0.1.0 tag

  

priority/P1

Must be settled before the first public contract freezes

  

priority/P2

Explicitly deferred until after v0.1.0

  

release/v0.1.0

Work tracked for the first tagged release

  

status/blocked

Cannot start now: waits on an upstream release, another issue, or a recorded revisit trigger

  

status/planned

Triaged with a source-grounded plan and a passed pi review; ready to implement

  

type/bug

Shipped behavior that contradicts the docs or the code's own intent; needs a product code change

  

type/design

An open scope or trade-off question; needs a recorded decision in the owning explanation doc before code

  

type/test-gap

Documented or reviewed behavior that no test pins; usually split from a review finding, needs no product code change

  

type/tracker

Parent issue that tracks child work

No labels

priority/P0

priority/P1

priority/P2

release/v0.1.0

status/blocked

status/planned

type/bug

type/design

type/test-gap

type/tracker

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

natsukium/felis!489

No description provided.