tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 12:05:37 +00:00
Code Issues Projects Releases Wiki Activity

DOC Add process for releasing individual module patches (#9626)

Browse Source 
Co-authored-by: Steve Boyd <emteknetnz@gmail.com>
This commit is contained in:
Garion Herman 2020-09-17 16:37:58 +12:00 committed by GitHub
parent a712000404
commit 0746230172
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/05_Contributing/05_Making_A_SilverStripe_Core_Release.md
View File

@ -20,6 +20,28 @@ While this document is not normally applicable to normal silverstripe contributo
it is still useful to have it available in a public location so that these users it is still useful to have it available in a public location so that these users
are aware of these processes. are aware of these processes.
## Module releases
Occasionally a fix to an individual module warrants a patch release outside of the standard quarterly release cycle. Rather than generating a full new recipe release, the following process should be followed to perform a patch release for an individual module:
1. Check out the module locally
1. Determine the new module version to be released (e.g. current version is 4.6.1, therefore new version will be 4.6.2)
1. Generate a changelog using our standard changelog format and the current release + branch name:
```
> git log --oneline --pretty=format:"* %s (%an) - %h" --no-merges 4.6.1...4.6
```
1. Draft a new Release in GitHub, targeting the correct branch, specifying the version to be released, and pasting the changelog in the description field.
1. Publish the release, and ensure the new version becomes visible in Packagist.
Projects wanting to pick up this individual patch will need to alias it in their `composer.json` file if they're using a recipe:
```
"requirements": {
"silverstripe/recipe-cms": "4.6.1",
"silverstripe/cms": "4.6.2 as 4.6.1"
}
```
## First time setup ## First time setup
As a core contributor it is necessary to have installed the following set of tools: As a core contributor it is necessary to have installed the following set of tools: