* feat(changelog): make changelog.header a template (#697)
* refactor: clean up implementation
* docs: update the description of header field
---------
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
See <https://git-cliff.org/docs/integration/github>
Squashed history:
* feat(github): support integration with GitHub repos
* fix(changelog): fix generation logic
* refactor(github): use verbose logging for errors
* fix(test): update tests accordingly to the render parameters
* feat(github): support deriving upstream URL from the repo
* docs(lib): update the description of the error module
* chore(github): add disclaimer for the github feature
* chore(config): filter the contributors in the github example
* fix(github): make GitHub login field optional
* chore(github): increase the logging verbosity for remote info
* refactor(git): reduce the log level for upstream remote
* feat(github): log the request error
* feat(args): add `--github-repo` argument
* feat(github): add caching for network requests
* feat(github): add progress bar for the network requests
* refactor(github): gate the implementation behind github feature flag
* fix(github): use the local cache for HTTP requests
* feat(github): set TCP keepalive value for HTTP client
* chore(cargo): create update-informer feature
* docs(website): add documentation about available features
* docs(website): reorder installation sections
* fix(config): skip serializing secret
* docs(website): add documentation about GitHub integration
* chore(example): update the style of GitHub config
* docs(website): add github example
* test(fixture): add test fixture for GitHub integration
* test(fixture): run the GitHub integration test
* fix(changelog): print header before fetching GitHub
* feat(github): allow using remote values without fetching GitHub
* chore(example): simplify Keep a Changelog example
* feat(example): add github-keepachangelog example
* chore(example): update the examples in default config
* chore(ci): test all features
* test(github): add unit tests for GitHub integration
* chore(ci): set upstream remote for tests
* chore(ci): show the current git status for test step
* chore(ci): skip git upstream test
* chore(ci): run tests without default features
* chore(ci): skip test with full name
* docs(website): add note about github-keepachangelog format
* chore(ci): skip the faulty git test for all test steps
* refactor(error): update the error type for logger
- Removes the version indicator in the first line. It was added with
the thought of incrementing but it never happened.
- Adds a reference to the full documentation.
* feat(config): changelog for the last n commits
Adds a additional configuration variable `limit_commits` to the
configuration struct.
`limit_commits` can be set to a positive integer number to limit the
commits contained in the generated changelog.
Also adjusts the default config file to contain `limit_commits` as a
commented out line.
Extends documentation in README.md to also cover the introduced
configuration value.
issue: https://github.com/orhun/git-cliff/issues/102
* test(fixture): add test fixture for limiting commits
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
* feat: support splitting commits by lines
* refactor(config): update the description for split_commits
* style(fmt): apply formatting via rustfmt
* refactor(test): create helper method for split_commits test
* fix(changelog): change the default behaviour for split_commits when it is not provided
* test(fixture): add test fixture for splitting commits
* docs(readme): update table of contents
* docs(readme): add warning about split_commits flag
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
* style: add newlines after the title to comply with MD022
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
* style: replace whitespaces with whitespace
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>