Skip to content

feat: automate SemVer releases with release-please (first release 2.0.0) - #26

Merged
TUNER88 merged 1 commit into
masterfrom
ci/release-please
Oct 18, 2026
Merged

TUNER88 merged 1 commit into
masterfrom
ci/release-please

Conversation

@TUNER88

@TUNER88 TUNER88 commented Oct 18, 2026

Copy link
Copy Markdown
Owner

This PR automates tags and GitHub Releases for the Swift package and switches the install snippets to from: "2.0.0". It's based on master and independent of the other PRs.

Release automation

  • .github/workflows/release-please.yml uses googleapis/release-please-action v5.0.0 (pinned SHA). It runs on push to master (and manually).
  • release-please-config.json: release-type: simple. Tags have no v prefix (2.0.0), and initial-version: 2.0.0 is set. .release-please-manifest.json starts empty.
  • This commit carries a Release-As: 2.0.0 footer and the feat: type. After merge, release-please opens chore(master): release 2.0.0. Merging that PR tags 2.0.0 and publishes the GitHub Release (and also creates CHANGELOG.md and version.txt).
  • .github/RELEASING.md explains the Conventional Commits rules and the token setup.

Branch protection / CI on release PRs
GitHub doesn't run workflows for PRs that GITHUB_TOKEN creates or updates, and master requires 11 checks. The workflow therefore uses secrets.RELEASE_PLEASE_TOKEN and falls back to GITHUB_TOKEN.

  • Recommended: add a fine-grained PAT (this repo; Contents, Pull requests and Issues: read and write) or a GitHub App token as the RELEASE_PLEASE_TOKEN repository secret.
  • Without it: the release PR is still created, and the workflow logs a warning. Close and reopen the release PR to start CI.

Release PRs are rebuilt on every push to master, so they stay up to date with strict mode.

Docs

  • README: a new ### Swift Package Manager subsection 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.
  • DocC Getting started: branch: "master" becomes from: "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-As footer survives. initial-version also yields 2.0.0 on its own.

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
TUNER88 merged commit 857e96e into master Oct 18, 2026
11 checks passed
@TUNER88
TUNER88 deleted the ci/release-please branch October 18, 2026 19:49
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.
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.

1 participant