README.md in gitlab_awesome_release-0.1.0.beta8 vs README.md in gitlab_awesome_release-0.1.0
- old
+ new
@@ -3,10 +3,12 @@
[](https://badge.fury.io/rb/gitlab_awesome_release)
[](https://gitlab.com/ci/projects/9759?ref=master)
[](https://gemnasium.com/19478d2f2735ee355f4c6cd1b8d2c12e)
+This is inspired by [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator)
+
## Example
see [CHANGELOG.md](CHANGELOG.md)
## Requirements
@@ -51,9 +53,35 @@
* The first tag to create a changelog
* default: oldest tag
* `--to-tag` , `TO_TAG`
* The last tag to create a changelog
* default: latest tag
+* `--filename` , `FILENAME`
+ * Filepath to changelog file (e.g. `CHANGELOG.md`)
+ * if empty, output to console
+* `--allow-tag-format` , `ALLOW_TAG_FORMAT`
+ * Tag format for release note heading (regular expresion pattern)
+ * default: `^v?[\d.]+`
+* `--log-level` , `LOG_LEVEL`
+ * Log level `(debug|info|warn|error|fatal|unknown)`
+ * default: `info`
+
+### `create_latest_note`
+generate release note only latest version and unreleased
+
+```sh
+$ gitlab_awesome_release create_latest_note
+```
+
+### options
+All options can be specified in both the command arguments and environment variables
+
+* `--gitlab-api-endpoint` , `GITLAB_API_ENDPOINT` **(either one is required)**
+ * GitLab API endpoint (e.g. `http://example.com/api/v3`)
+* `--gitlab-api-private-token` , `GITLAB_API_PRIVATE_TOKEN` **(either one is required)**
+ * Your private token. see [/profile/account](img/private_token.png)
+* `--gitlab-project-name` , `GITLAB_PROJECT_NAME` **(either one is required)**
+ * Target project (e.g. `group/repo_name`)
* `--filename` , `FILENAME`
* Filepath to changelog file (e.g. `CHANGELOG.md`)
* if empty, output to console
* `--allow-tag-format` , `ALLOW_TAG_FORMAT`
* Tag format for release note heading (regular expresion pattern)