Skip to content

docs: drop release-please references for manual release flow #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Zakariya1057 merged 1 commit into from
Jun 1, 2026
Merged

docs: drop release-please references for manual release flow #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Closes #
- [ ] No API keys, session IDs, or credentials in the diff
- [ ] `README.md` updated if public API or behavior changed
- [ ] SwiftUI and UIKit example ladders mirrored (if SDK behavior changed)
- [ ] `Version.swift` not edited by hand (release-please owns it)
- [ ] `Version.swift` not touched (it is bumped only when cutting a release)

## Screenshots / recordings

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If you change the SDK, mirror the change across the SwiftUI and UIKit example la

## Commit conventions

This repository uses [Conventional Commits](https://www.conventionalcommits.org/) and [release-please](https://github.com/googleapis/release-please) to manage versioning and `CHANGELOG.md`.
This repository uses [Conventional Commits](https://www.conventionalcommits.org/) for commit messages. Versioning and `CHANGELOG.md` are maintained by hand when cutting a release.

| Type | Effect on version (pre-1.0) |
|------------|------------------------------------------|
Expand All @@ -80,11 +80,11 @@ chore(release): 0.5.0

## Releases

Releases are driven by release-please:
Releases are cut manually:

1. Conventional commits land on `main`.
2. The release-please workflow maintains an open Release PR that bumps `Sources/PolyMessaging/Public/Version.swift`, updates `CHANGELOG.md`, and tags `vX.Y.Z` on merge.
3. The version literal in `Version.swift` is the single source of truth — it is the User-Agent the SDK sends and the version surfaced to example apps. **Do not edit it by hand.**
2. To cut a release, bump `Sources/PolyMessaging/Public/Version.swift`, add a matching entry to `CHANGELOG.md`, then tag `vX.Y.Z`.
3. The version literal in `Version.swift` is the single source of truth — it is the User-Agent the SDK sends and the version surfaced to example apps. **Bump it only when cutting a release, never in feature PRs.**

## Verifying changes before opening a PR

Expand Down