Skip to content

Commit cbaad9c

Browse files
committed
docs: update release process instructions
- Clarify that release branch naming is a suggestion - Make cargo build step optional - Add explicit steps for creating and pushing version tags - Simplify formatting for better readability
1 parent 346d666 commit cbaad9c

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,18 +109,23 @@ $ mv signature.rs src/pb_signature.rs
109109
This project follows [Semantic Versioning](https://semver.org/) (M.m.p = Major.minor.patch).
110110
111111
1. **Prepare the release:**
112-
- Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`)
113-
- Update version in `Cargo.toml`, `action.yml`, and `Dockerfile`
114-
- Run `cargo build` to update `Cargo.lock` with the new version
115-
- Commit changes with format: `vM.m.p` for the version update, and `chore: bump CLI version in Cargo.lock` for the lockfile
112+
- Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`). This is just a suggestion; you can name the branch as you prefer.
113+
- Update version in `Cargo.toml`, `action.yml`, and `Dockerfile`
114+
- Run `cargo build` to update `Cargo.lock` with the new version. This step is optional but recommended.
116115
117116
2. **Create and merge the pull request:**
118-
- Create a pull request from the release branch to `master`
119-
- Once approved and merged, the tag will be pushed automatically
117+
- Create a pull request from the release branch to `master`
118+
- Once approved, merge the pull request
120119
121120
3. **Create the GitHub release:**
122-
- The CI/CD pipeline will detect the version tag and create the release automatically
123-
- Add the release notes to the GitHub release description
121+
- Make sure that you're on the `master` branch and have pulled the latest changes
122+
- Create a version tag (e.g., `vM.m.p`, like `v1.0.h6`) and push it to GitHub by running:
123+
```bash
124+
git tag vM.m.p
125+
git push origin vM.m.p
126+
```
127+
- The release workflow will detect the version tag and create the release automatically
128+
- Add the release notes to the GitHub release description
124129
125130
4. **Update Homebrew:**
126131
- Update the [Homebrew repo](https://github.com/Screenly/homebrew-screenly-cli) with the latest version

0 commit comments

Comments
 (0)