Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magento/magento-semver
Magento Semantic Versioning Checker. Join #svc in our Community Slack: https://opensource.magento.com/slack. Static tests that identify required module version changes based on code diff, and look for backward incompatible changes.
https://github.com/magento/magento-semver
Last synced: 5 days ago
JSON representation
Magento Semantic Versioning Checker. Join #svc in our Community Slack: https://opensource.magento.com/slack. Static tests that identify required module version changes based on code diff, and look for backward incompatible changes.
- Host: GitHub
- URL: https://github.com/magento/magento-semver
- Owner: magento
- License: other
- Created: 2019-06-12T14:45:55.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-09T17:14:33.000Z (2 months ago)
- Last Synced: 2024-09-09T21:28:28.369Z (2 months ago)
- Language: PHP
- Homepage:
- Size: 950 KB
- Stars: 31
- Watchers: 22
- Forks: 25
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Magento Semantic Version Checker
## Installation
- `git clone [email protected]:magento/magento-semver.git`
- `cd magento-semver`
- `composer install`
## Usage
- `php bin/svc --help`
### Commands
- `php bin/svc compare` - Compare a set of files to determine what semantic versioning change needs to be done.
- `php bin/svc update-breaking-changes` - Update the file with a list of backward incompatible changes between two sources.
### Releases & Versioning
#### Releases
- Magento-semver development should happen against the `develop` branch.
- New releases will shipped monthly. However, new releases will only occur if the `develop` branch has diverged from the `master` branch.
- 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.
#### Versioning
- Versions will be handled via GitHub Tags.
- 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`.
- With each new version, the `composer.json` file must be updated to match the new target version before creating a tag.
- After a new version is released, `magento-semver` will be packaged and published to `repo.magento.com` for consumption.
## Tests
- `vendor/bin/phpunit -c tests/Unit/phpunit.xml.dist`