diff options
author | n-peugnet <n.peugnet@free.fr> | 2019-10-24 00:46:57 +0200 |
---|---|---|
committer | n-peugnet <n.peugnet@free.fr> | 2019-10-24 00:46:57 +0200 |
commit | e7c212e15bffe780f4cdf1e683d3c2391c3b8db3 (patch) | |
tree | 52e84818b6b47d16b1d07c9212dc43ffbf17e0fc | |
parent | 32ddaa0b721c79cd96c77f1622099b8a409a4a86 (diff) | |
download | wcms-e7c212e15bffe780f4cdf1e683d3c2391c3b8db3.tar.gz wcms-e7c212e15bffe780f4cdf1e683d3c2391c3b8db3.zip |
docs: add publish release informations
-rw-r--r-- | README.md | 21 |
1 files changed, 16 insertions, 5 deletions
@@ -46,7 +46,7 @@ There is lot more you can by altering the `BODY`. using [James Moss's Flywheel Database](https://github.com/jamesmoss/flywheel), [Michel Fortin's Markdown Extra](https://github.com/michelf/php-markdown) and [Plates](https://github.com/thephpleague/plates) as lightweight template engine. -# Install from sources +# Development informations If you want to contribute to the project. @@ -60,7 +60,7 @@ If you want to contribute to the project. sudo apt install php composer nodejs -## Installation +## Install from sources 1. Clone the git repository. 2. Install PHP dependencies. @@ -71,15 +71,26 @@ If you want to contribute to the project. npm install && npm run build -## Development +## JS development While developing the JS sources it is useful to run webpack in watch mode so that the bundles get built at each file change. To do so, use the following command: npm run watch -## Release zip +## Publish a new release -To build the release zip, make sure you are on `master` and executed `git pull` then run `make dist`. This will create a zip file in `dist/`. +The release process uses [release-it](https://github.com/release-it/release-it), so to create and publish a new release you will need a [GitHub personnal access token](https://github.com/settings/tokens) with repository access, saved in a `.env` file like so: + +```bash +# .env +GITHUB_TOKEN='{{github token value}}' +``` + +Then, to make the release, run the following command: + + make release + +To only build the release zip, simply run `make dist`. This will create a zip file in `dist/` of the current version. To Do |