Skip to content

Commit 4f69c9b

Browse files
authored
Fix #205: Document branching policy (#461)
1 parent 387063e commit 4f69c9b

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

src/internals/020-package-release.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,30 @@
1212
- phpdoc is alright.
1313
- Public API is alright.
1414

15+
## Release branch policy
16+
17+
Use `master` for all regular releases.
18+
19+
Create a separate branch only when releasing a new version for a previous major version. In this case, create the
20+
branch from the latest tag in that previous major version line and apply only the changes needed for the release.
21+
1522
## Release instruction
1623

1724
Release a package via [Yii Development Tool](005-development-tool.md).
1825

1926
1. Check that you can sign commits locally (see
2027
[Signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)).
2128

22-
2. Pull last changes from the `master` branch:
29+
2. For regular releases, pull last changes from the `master` branch:
2330

2431
```shell
2532
./yii-dev git/checkout master package-name
2633
./yii-dev git/pull package-name
2734
```
2835

36+
For previous major version releases, use the branch created according to the release branch policy instead of
37+
`master`.
38+
2939
3. Check the package for compliance with the criteria above.
3040

3141
4. Run `release/make` command:
@@ -34,7 +44,7 @@ Release a package via [Yii Development Tool](005-development-tool.md).
3444
./yii-dev release/make package-name
3545
```
3646

37-
5. Select the version type (major, minor or path).
47+
5. Select the version type (major, minor or patch).
3848

3949
6. On the question "Push commits and tags, and release on GitHub?" check a diff. If the diff is alright, answer "yes."
4050

0 commit comments

Comments
 (0)