mirror of
https://github.com/orhun/git-cliff.git
synced 2024-09-19 03:08:30 +03:00
44c93b7c70
* test: add more tests for previous links * fix: fix wrong previous version * test: fix wrong tag on test fixture * test: add fixture for bump with keep a changelog links * perf: avoid setting previous if already set * style: remove unused comment * refactor: change code style for readability * fix: fix compilation failure * docs: update with comments * style: reformat code --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> |
||
---|---|---|
.. | ||
new-fixture-template | ||
test-bump-version | ||
test-bumped-version | ||
test-commit-footers | ||
test-commit-preprocessors | ||
test-custom-scope | ||
test-date-order | ||
test-footer-template | ||
test-ignore-tags | ||
test-keep-a-changelog-links | ||
test-keep-a-changelog-links-current-arg | ||
test-keep-a-changelog-links-latest-arg | ||
test-keep-a-changelog-links-no-tags | ||
test-keep-a-changelog-links-one-tag | ||
test-keep-a-changelog-links-one-tag-bump-arg | ||
test-keep-a-changelog-links-tag-arg | ||
test-keep-a-changelog-links-unreleased-arg | ||
test-latest-with-one-tag | ||
test-limit-commits | ||
test-regex-replace-parser | ||
test-skip-breaking-changes | ||
test-split-commits | ||
test-topo-order | ||
test-topo-order-arg | ||
README.md | ||
test-fixtures-locally.sh |
Fixtures
Test fixtures are a way of testing the git-cliff
's functionality against a configuration file (cliff.toml
) and asserting the output (expected.md
).
They are being run as a part of the GitHub Actions and the workflow file can be viewed here.
Adding new fixtures
- Copy the
new-fixture-template
astest-<functionality>
. - Update the files accordingly to the function that is being tested.
- Run the fixture locally. (see below)
- Add the fixture to
test-fixtures.yml
matrix.- If you need to specify custom arguments to
git-cliff
for the fixture test, you can do it here with usingcommand
.
- If you need to specify custom arguments to
- Commit your changes.
See this commit as an example.
Running locally
To run the fixtures locally:
./test-fixtures-locally.sh <fixture_name>