diff options
| author | Camila San <hello@camila.codes> | 2018-12-05 23:23:05 +0300 |
|---|---|---|
| committer | Camila San <hello@camila.codes> | 2018-12-05 23:56:46 +0300 |
| commit | 404f1e6037911fa8123b51c8969dadda18c6c256 (patch) | |
| tree | 72a2eeae9738b4851d9b6e30e514ee807e5a059a /README.md | |
| parent | 1d406ca710b995d44444b1317974118bd7dc290c (diff) | |
Adds option to pick repository to create changelog.
- Pass repository name as the first parameter to php index.php generate:changelog command.
- Based on the repo it sets the default values for fetching the commits.
- Remove android.php
- Updates README with instructions about the new parameter repo name.
Signed-off-by: Camila San <hello@camila.codes>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 16 insertions, 8 deletions
@@ -17,22 +17,30 @@ All the scripts inside this repo need a `credentials.json` in their home folder * provide the credentials by placing a copy of `credentials.dist.json` as `credentials.json` in the root of this folder * go into `changelog/` * install [composer](https://getcomposer.org/download/) dependencies: `composer install` -* run the command `php index.php generate:changelog v13.0.0 stable13` to generate the changelog for the upcoming 13.0.1 release -This script automatically derives the milestone from the first argument "v13.0.0" will mean that the milestone "13.0.1" will be checked for pending pull requests. +### Generate changelog command -There is a format option to generate output for: +Syntax: + + ``` +php index.php $repoName generate:changelog $base $head --format=$format + ``` + +The format setting has the following options: * Github (default) * forum (`--format=forum` - Markdown with absolute links) * changelog page on our website (`--format=html` - HTML list with absolute links) +E.g. to generate the changelog for the upcoming 13.0.1 server release. This script automatically derives the milestone from the first argument "v13.0.0" will mean that the milestone "13.0.1" will be checked for pending pull requests: - ### Android changelog +``` +php index.php server generate:changelog v13.0.0 stable13 +``` - * there is also an android changelog in there: +E.g. generate the changelog for the upcoming 3.3.0 Android release: - ``` - php index.php generate:changelog stable-3.3.0 stable-3.3.x - ``` +``` +php index.php android generate:changelog stable-3.3.0 stable-3.3.x +``` |