Skip to content

docs: release candidates from the next branch #126

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
pashidlos merged 1 commit into from
Nov 3, 2026
Merged

docs: release candidates from the next branch #126

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/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: CI

on:
push:
branches: [ master ]
branches: [ master, next ]
pull_request:

permissions:
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,14 @@ JitPack builds the SDK from a git tag; there is nothing to upload.

JitPack runs `./gradlew clean -Pgroup=com.github.Visual-Regression-Tracker -Pversion=<tag> -xtest assemble publishToMavenLocal` on the JDK from `jitpack.yml`, so the artifact version is always the tag. `version` in `gradle.properties` is only the default for local builds. CI runs the same command on Java 25 for every pull request.

### Release candidates

Breaking changes for the next major go into `next` through pull requests against it. Merge `master` into `next` when `master` gets new commits.

To release a candidate, make sure `next` is green, then `gh release create X.Y.Z-rc.N --target next --prerelease --notes-file <notes>` (for example `6.0.0-rc.1`) tags `next` and creates the pre-release; then start the JitPack build as in step 4. Projects get it only by asking for that exact version.

To release the final version, merge `next` into `master` with a merge commit, then tag `master` as above. The repository deletes merged branches, so create `next` again from `master` before the next round of candidates.

## Links

- [Java examples](https://github.com/Visual-Regression-Tracker/examples-java)
Expand Down
Loading