Skip to content

Commit 43d4f6d

Browse files
Copilotswissspidy
andcommitted
Update README to document correct branch-alias behavior
Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
1 parent 7323251 commit 43d4f6d

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ This repository contains reusable GitHub Actions workflows that are automaticall
2323

2424
The branch alias checker workflow automatically ensures that the Composer `branch-alias` in each repository's `composer.json` is up-to-date. It:
2525

26-
1. Runs weekly (every Monday at 2 AM UTC) or can be triggered manually
26+
1. Runs on every release or can be triggered manually
2727
2. Checks the latest release tag
28-
3. Calculates the expected branch-alias (next minor version after the latest release)
29-
4. Compares with the current branch-alias
28+
3. On a new major release (`vX.0.0`), updates the branch-alias to `X.x-dev`
29+
4. Skips minor and patch releases, as the branch-alias should remain unchanged
3030
5. Creates a pull request if an update is needed
3131

32-
For example, if a repository has released version `2.12.0`, the branch-alias should be set to `2.13.x-dev` to point to the next development version.
32+
For example, if a repository releases `v2.2.6` or `v2.3.0`, the branch-alias stays at `2.x-dev`. Only when releasing `v3.0.0` should it change to `3.x-dev`.
3333

3434
## Installing
3535

0 commit comments

Comments
 (0)