mirror of
https://github.com/git-chglog/git-chglog.git
synced 2026-01-23 02:15:12 +00:00
chore: update readme and changelog for v0.11.1
This commit is contained in:
parent
e6e7a69a7d
commit
54bb7363dc
2 changed files with 29 additions and 13 deletions
|
|
@ -5,6 +5,12 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
|
|||
<a name="unreleased"></a>
|
||||
## [Unreleased]
|
||||
|
||||
<a name="v0.11.1"></a>
|
||||
## [v0.11.1] - 2021-03-12
|
||||
|
||||
### Bug Fixes
|
||||
- **short flags**: correctly define cli flags with shorthands ([#117](https://github.com/git-chglog/git-chglog/issues/117))
|
||||
|
||||
<a name="v0.11.0"></a>
|
||||
## [v0.11.0] - 2021-03-12
|
||||
### Features
|
||||
|
|
@ -171,7 +177,8 @@ https://github.com/git-chglog/git-chglog/releases/download/v<VERSION>/git-chglog
|
|||
- First implement
|
||||
|
||||
|
||||
[Unreleased]: https://github.com/git-chglog/git-chglog/compare/v0.11.0...HEAD
|
||||
[Unreleased]: https://github.com/git-chglog/git-chglog/compare/v0.11.1...HEAD
|
||||
[v0.11.1]: https://github.com/git-chglog/git-chglog/compare/v0.11.0...v0.11.1
|
||||
[v0.11.0]: https://github.com/git-chglog/git-chglog/compare/v0.10.0...v0.11.0
|
||||
[v0.10.0]: https://github.com/git-chglog/git-chglog/compare/0.9.1...v0.10.0
|
||||
[0.9.1]: https://github.com/git-chglog/git-chglog/compare/0.9.0...0.9.1
|
||||
|
|
|
|||
33
README.md
33
README.md
|
|
@ -181,18 +181,23 @@ USAGE:
|
|||
4. <name> - Commit contained in <name>.
|
||||
|
||||
OPTIONS:
|
||||
--init generate the git-chglog configuration file in interactive
|
||||
--path value Filter commits by path(s). Can use multiple times.
|
||||
--config value, -c value specifies a different configuration file to pick up (default: ".chglog/config.yml")
|
||||
--output value, -o value output path and filename for the changelogs. If not specified, output to stdout
|
||||
--next-tag value treat unreleased commits as specified tags (EXPERIMENTAL)
|
||||
--silent disable stdout output
|
||||
--no-color disable color output [$NO_COLOR]
|
||||
--no-emoji disable emoji output [$NO_EMOJI]
|
||||
--no-case disable case sensitive filters
|
||||
--tag-filter-pattern value, -p value regular expression of tag filter. Is specified, only matched tags will be picked
|
||||
--help, -h show help
|
||||
--version, -v print the version
|
||||
--init generate the git-chglog configuration file in interactive (default: false)
|
||||
--path value Filter commits by path(s). Can use multiple times.
|
||||
--config value, -c value specifies a different configuration file to pick up (default: ".chglog/config.yml")
|
||||
--template value, -t value specifies a template file to pick up. If not specified, use the one in config
|
||||
--repository-url value specifies git repo URL. If not specified, use 'repository_url' in config
|
||||
--output value, -o value output path and filename for the changelogs. If not specified, output to stdout
|
||||
--next-tag value treat unreleased commits as specified tags (EXPERIMENTAL)
|
||||
--silent disable stdout output (default: false)
|
||||
--no-color disable color output (default: false) [$NO_COLOR]
|
||||
--no-emoji disable emoji output (default: false) [$NO_EMOJI]
|
||||
--no-case disable case sensitive filters (default: false)
|
||||
--tag-filter-pattern value Regular expression of tag filter. Is specified, only matched tags will be picked
|
||||
--jira-url value Jira URL [$JIRA_URL]
|
||||
--jira-username value Jira username [$JIRA_USERNAME]
|
||||
--jira-token value Jira token [$JIRA_TOKEN]
|
||||
--help, -h show help (default: false)
|
||||
--version, -v print the version (default: false)
|
||||
|
||||
EXAMPLE:
|
||||
|
||||
|
|
@ -220,6 +225,10 @@ EXAMPLE:
|
|||
$ git-chglog --config custom/dir/config.yml
|
||||
|
||||
The above is a command that uses a configuration file placed other than ".chglog/config.yml".
|
||||
|
||||
$ git-chglog --path path/to/my/component --output CHANGELOG.component.md
|
||||
|
||||
Filter commits by specific paths or files in git and output to a component specific changelog.
|
||||
```
|
||||
|
||||
### `tag query`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue