beenull/Pico
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

CONTRIBUTING.md: Update build & release process

Browse source
This commit is contained in:
Daniel Rudolf 2015-11-29 17:18:46 +01:00
parent b18464adba
commit 372979e45b
1 changed files with 11 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
CONTRIBUTING.md
View file

@ -80,27 +80,18 @@ As soon as development reaches a point where feedback is appreciated, a pull req
Build & Release process
-----------------------
> This is work in progress. Please refer to [#268](https://github.com/picocms/Pico/issues/268) for details.
We're using [Travis CI](https://travis-ci.com) to automate the build & release process of Pico. It generates and deploys [phpDoc](http://phpdoc.org) class docs for new releases and on every commit to the `master` branch. Travis also prepares new releases by generating Pico's pre-built packages and uploading them to GitHub. Please refer to [our `.travis.yml`](https://github.com/picocms/Pico/blob/master/.travis.yml) for details.
We're using [Travis CI](https://travis-ci.com) to automate the build & release process of Pico. It generates and deploys [phpDoc](http://phpdoc.org) class docs for new releases and on every commit to the `master` branch. Travis also prepares new releases by generating Pico's pre-built packages and uploading them to GitHub.
As elucidated above, it's important that each commit to `master` is deployable. Once development of a new Pico release is finished, trigger Pico's build & release process by pushing a new Git tag. This tag should reference a (usually empty) commit on `master`, which message should follow the following template:
It is important that each commit to `master` is deployable. Once a `feature/branch` or the `master` branch have reached a point where the need for a version increase is necessary, you can trigger this process by pushing a new Git Tag. The tag references a (usually empty) commit which message follows the following template:
```
Version 1.0.0
Example:
```
Pico Version 1.0.1
* [New] ...
* [Changed] ...
* [Removed] ...
* [Security] ...
```
* [Security] ...
* [New] ...
* [Changed] ...
* [Fixed] ...
* [Removed] ...
```
<!-- __Please submit pull-requests with a properly formatted commit message and
[SemVer](http://semver.org) increase to avoid the need for manual amendments.__ -->
After deploying a new release, you will need to amend the release information on GitHub with the release title (taken from changelog), and changelog itself.
__Note__
- Releases will be available at: [https://github.com/picocms/Pico/releases](https://github.com/picocms/Pico/releases)
- Pico will be automatically updated on [Packagist](http://packagist.org/packages/picocms/pico)
Travis CI will draft the new [release on GitHub](https://github.com/picocms/Pico/releases) automatically, but will require you to manually amend the descriptions formatting. The latest Pico version is always available at https://github.com/picocms/Pico/releases/latest, so please make sure to publish this URL rather than version-specific URLs. [Packagist](http://packagist.org/packages/picocms/pico) will be updated automatically.