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

add travis-ci information

Browse source
This commit is contained in:
theshka 2015-10-28 10:12:03 -06:00
parent 2fd3c68ea8
commit 34911fc84c
1 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
_plugin-dev/basics.md
View file

@ -3,18 +3,16 @@ toc:
basics:
_title: Basics
versioning: Versioning
build_&_release: Build & Release
build--release: Build & Release
nav: 1
---
# Basics
Creating your own content for Pico is *easy*.
Inside the root Pico folder, all *themes* reside in the `themes` directory,
and all *plugins* in the `plugins` directory. (As a developer, you may have
changed these paths and/or directory names when you initialized Pico.)
Inside the root Pico folder, all *themes* reside in the `themes` directory, 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/).
Note that if you are submitting pull requests they should be small (i.e. one feature per request), stick to existing coding conventions and documentation should be updated if required.
# Versioning
Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
@ -26,11 +24,21 @@ Pico uses Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increme
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.
Defined below is a specification to which the Build and Release process of Pico should follow. We use `travis-ci` to automate the process, and each commit to `master` should be releasable.
### Commit phase
- Commit changes
- Create & Push Git tag
- Trigger automatic build process...
Example commit message:
Pico 1.0.1
* [New] ...
* [Changed] ...
*Please submit pull-requests with a properly
formatted commit message/SemVer increase to avoid the need for manual amendments.*
### Analysis phase
- Run through `scrutinizer-ci`?
@ -38,7 +46,7 @@ Each commit to `master` should be releasable, otherwise make use of the `develop
### 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
- Build documentation, output goes to a new folder in the `gh-pages` branch
### Release phase
- Create new Git release at tag
@ -50,4 +58,4 @@ Each commit to `master` should be releasable, otherwise make use of the `develop
- Changelog
### Announcements
-
- Where to announce new Pico release?