Repository navigation
feat: automate SemVer releases with release-please (first release 2.0.0) - #26
Merged
Merged
Conversation
Add release-please automation (release-type simple). It opens a release PR from Conventional Commits and creates SemVer tags and GitHub Releases. README and DocC install snippets now use from: "2.0.0". Release-As: 2.0.0
TUNER88
added a commit
that referenced
this pull request
Nov 1, 2026
…e is optional (#32) The repo is primarily a reference: SystemSoundIDs and file lists, plus copy-paste `AudioToolbox` snippets. This PR makes the README and DocC say so, and presents the Swift package only as an optional convenience. **README** - **Intro:** the bullet advertising the package's API docs is replaced by: *"The usage snippets call `AudioToolbox` directly. Copy and paste them; no dependency is needed."* - **Usage:** the original sentence stays, and a new line follows it: *"The snippets below work as is. You don't need a third-party dependency to play system sounds."* Swift, SwiftUI and Objective-C snippets now come first. - **`### Swift Package Manager`:** the heading text is unchanged, so the `#swift-package-manager` anchor still works. The section moved from the top of Usage to after Objective-C and is shortened to one sentence (*"Optional, and not needed to play system sounds…"*), a docs link and one snippet. The SoundBrowser pointer was removed from this section. - **Contents:** that entry moved below Objective-C, with the text *"Optional: Swift package"*. The anchor is unchanged. - **What changed and what didn't:** the only removed lines are ones added recently in #26 and #28. The ID table (125 rows) and the iOS 7.0.2 list are byte-identical, all headings and anchors are present, the must-not-break check passes (including `--online`), and the generated sections are up to date. **DocC** - **Landing page:** the abstract now says the package is *"an optional convenience layer"*. The overview opens with *"You don't need this package to play system sounds"* and the one-line `AudioServicesPlaySystemSound(1003)` call, then points to the README tables, and only then shows the package API. - **Getting started:** a new first section, **"You may not need this package"**, shows the AudioToolbox one-liner. **"Add the package"** is now **"Add the package (optional)"**. **Repo metadata:** the description ("List of all system sounds used in iOS") doesn't emphasize the package, and there are no topics. Neither was changed. Commit type `docs:`, so this doesn't trigger a release.
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.
This PR automates tags and GitHub Releases for the Swift package and switches the install snippets to
from: "2.0.0". It's based onmasterand independent of the other PRs.Release automation
.github/workflows/release-please.ymluses googleapis/release-please-action v5.0.0 (pinned SHA). It runs on push tomaster(and manually).release-please-config.json:release-type: simple. Tags have novprefix (2.0.0), andinitial-version: 2.0.0is set..release-please-manifest.jsonstarts empty.Release-As: 2.0.0footer and thefeat:type. After merge, release-please openschore(master): release 2.0.0. Merging that PR tags2.0.0and publishes the GitHub Release (and also createsCHANGELOG.mdandversion.txt)..github/RELEASING.mdexplains the Conventional Commits rules and the token setup.Branch protection / CI on release PRs
GitHub doesn't run workflows for PRs that
GITHUB_TOKENcreates or updates, andmasterrequires 11 checks. The workflow therefore usessecrets.RELEASE_PLEASE_TOKENand falls back toGITHUB_TOKEN.RELEASE_PLEASE_TOKENrepository secret.Release PRs are rebuilt on every push to
master, so they stay up to date with strict mode.Docs
### Swift Package Managersubsection under Usage, plus one TOC line. Nothing existing changes: verified 0 removed or changed lines, the ID table and iOS 7.0.2 list are byte-identical, and all anchors are present.branch: "master"becomesfrom: "2.0.0". That version resolves once the 2.0.0 release PR is merged.Merge with a merge commit or squash. For a squash, keep the commit body so the
Release-Asfooter survives.initial-versionalso yields 2.0.0 on its own.