Auto-bump README DMG link on app releases#5
Merged
Conversation
Each app-v* tag now triggers a step in release-app.yml that, after the DMG is signed + notarized + uploaded to GitHub Releases, rewrites a marker block in README.md so the public download link always points at the freshly-released version. The marker: <!-- LATEST_DMG_BEGIN --> …auto-generated link block… <!-- LATEST_DMG_END --> awk does the multi-line splice (sed -i differs between BSD and GNU); idempotent — if the marker block already matches the new version, no commit lands. Push to origin/main is gated on github.event_name=='push' so manual workflow_dispatch dry-runs never mutate main. The CI `paths-ignore: '**/*.md'` rule means the bot commit doesn't re-trigger the pipeline; `[skip ci]` in the commit message is belt-and-suspenders. Also restores the DMG download line in the Install section (pointing at the current 0.1.0 release) so the marker block has a body to operate on. Future app releases bump just the version inside.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Each `app-v*` tag now bumps the README's DMG download link to the freshly-released version automatically. No more hand-editing the link on every release.
How it works
A marker block in the README:
```html
Download the latest DMG: Keywordista-X.Y.Z.dmg (signed + notarized). …
```
After the `Create GitHub Release` step lands the DMG + checksum, a new `Bump README DMG link to this release` step:
The PR also restores the DMG section to the README's Install block (pointing at the current 0.1.0 release) so the marker block has a body to operate on — and so the public README has a usable download link from day one.
Safety
Test plan