Skip to content

Commit 7ee8840

Browse files
authored
Update README.md: Add information about releases and versioning (#24)
1 parent 72b35de commit 7ee8840

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Diff for: README.md

+15
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,20 @@
1313
- `php bin/svc compare` - Compare a set of files to determine what semantic versioning change needs to be done.
1414
- `php bin/svc update-breaking-changes` - Update the file with a list of backward incompatible changes between two sources.
1515

16+
### Releases & Versioning
17+
18+
#### Releases
19+
20+
- Magento-semver development should happen against the `develop` branch.
21+
- New releases will shipped monthly. However, new releases will only occur if the `develop` branch has diverged from the `master` branch.
22+
- If a hot-fix needs to be applied, a new release may be cut at any time. If this happens, the release cycle does not change.
23+
24+
#### Versioning
25+
26+
- Versions will be handled via GitHub Tags.
27+
- Only `MAJOR` versions, as understood by the Semantic Versioning specification, are allowed; e.g.: increasing from version `2.0.0` to version `3.0.0`.
28+
- With each new version, the `composer.json` file must be updated to match the new target version before creating a tag.
29+
- After a new version is released, `magento-semver` will be packaged and published to `repo.magento.com` for consumption.
30+
1631
## Tests
1732
- `vendor/bin/phpunit -c tests/Unit/phpunit.xml.dist`

0 commit comments

Comments
 (0)