Skip to content

Commit 1223282

Browse files
grdsdevclaude
andcommitted
docs: update RELEASE.md for release-please workflow
- Replace semantic-release documentation with release-please flow - Update configuration file references - Clarify the automated release process with release PRs - Remove outdated semantic-release and rc branch information 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 76dc3f0 commit 1223282

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

RELEASE.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Semantic Release Setup
1+
# Release-Please Setup
22

3-
This project uses [semantic-release](https://semantic-release.gitbook.io/) to automate version management and package publishing.
3+
This project uses [release-please](https://github.com/googleapis/release-please) to automate version management and package publishing.
44

55
## How it works
66

77
1. **Commit messages** follow the [Conventional Commits](https://www.conventionalcommits.org/) specification
8-
2. **Semantic-release** analyzes commits and determines the next version number
9-
3. **GitHub Actions** automatically creates releases when changes are pushed to `main`
8+
2. **Release-please** analyzes commits and determines the next version number
9+
3. **GitHub Actions** automatically creates release PRs and publishes releases
1010

1111
## Commit Message Format
1212

@@ -47,38 +47,30 @@ BREAKING CHANGE: This removes the old API
4747

4848
## Release Process
4949

50-
### Regular Releases (main branch)
50+
### Automated Release Flow
5151

52-
1. Push commits to `main` branch
53-
2. GitHub Actions runs semantic-release
54-
3. If there are releasable changes:
52+
1. **Push commits** to `main` branch with conventional commit messages
53+
2. **Release-please** analyzes commits and creates a release PR when needed
54+
3. **Review and merge** the release PR to trigger the actual release:
5555
- Version is updated in `Sources/Helpers/Version.swift`
5656
- `CHANGELOG.md` is updated
57-
- Git tag is created
57+
- Git tag is created (e.g., `v2.33.0`)
5858
- GitHub release is published
5959

60-
### Release Candidates (rc branch)
60+
### Release Branches
6161

62-
1. Push commits to `rc` branch
63-
2. GitHub Actions runs semantic-release
64-
3. If there are releasable changes:
65-
- Prerelease version is created (e.g., `2.31.0-rc.1`)
66-
- Version is updated in `Sources/Helpers/Version.swift`
67-
- `CHANGELOG.md` is updated
68-
- Git tag is created
69-
- GitHub prerelease is published
62+
Release-please also supports `release/*` branches for managing releases from feature branches if needed.
7063

7164
## Manual Release
7265

73-
To manually trigger a release:
66+
To manually trigger the release-please workflow:
7467

7568
1. Go to Actions tab in GitHub
76-
2. Select "Semantic Release" workflow
69+
2. Select "Release" workflow
7770
3. Click "Run workflow"
7871

7972
## Configuration Files
8073

81-
- `.releaserc.json`: Semantic-release configuration
82-
- `package.json`: Node.js dependencies
74+
- `release-please-config.json`: Release-please configuration
75+
- `.release-please-manifest.json`: Current version tracking
8376
- `.github/workflows/release.yml`: GitHub Actions workflow
84-
- `scripts/update-version.sh`: Version update script

0 commit comments

Comments
 (0)