diff --git a/_plugin-dev/basics.md b/_plugin-dev/basics.md index ff20941..3dc19d8 100644 --- a/_plugin-dev/basics.md +++ b/_plugin-dev/basics.md @@ -1,6 +1,9 @@ --- toc: - basics: Basics + basics: + _title: Basics + versioning: Versioning + build_&_release: Build & Release nav: 1 --- @@ -12,3 +15,39 @@ and all *plugins* in the `plugins` directory. (As a developer, you may have changed these paths and/or directory names when you initialized Pico.) Besides this documentation please also refer to our [phpDoc](phpDocumentor/). + +# Versioning +Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the: + +- MAJOR version when you make incompatible API changes, +- MINOR version when you add functionality in a backwards-compatible manner, and +- PATCH version when you make backwards-compatible bug fixes. + +For more information see the [http://semver.org](http://semver.org) website. + +# Build & Release +Defined below is a specification to which the Build and Release process of Pico should follow. +Each commit to `master` should be releasable, otherwise make use of the `development` branch. + +### Commit phase +- Create & Push Git tag + +### Analysis phase +- Run through `scrutinizer-ci`? + +### Packaging phase +- Run composer locally +- Create a ZIP archive (so vendor/ is included) +- Build documentation, output goes to a new folder in the gh-pages branch + +### Release phase +- Create new Git release at tag +- Upload ZIP archive +- Upload documentation to the `gh-pages` branch +- Set Symlink for latest documentation (http://picocms.org/docs/latest) +- Update release information on GitHub with: + - Release title (taken from changelog) + - Changelog + +### Announcements +-