mirror of
https://github.com/orhun/git-cliff.git
synced 2024-11-29 13:32:20 +03:00
87e2c1d0dd
* feat(core): add `remote` field to commit * refactor * fmt * deprecate old fields * serialize remote field * fix * fix typo * allow deprecated * move warn * move filename * docs * docs * fix * fmt * chore(fixtures): use remote instead of platform name for template variables * remove useless method * update docs * use contains_variable * fix no-default-features * chore(remote): update template varibles for platforms * set commit.remote * chore(release): update unit tests for new remote field --------- Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com> |
||
---|---|---|
.. | ||
new-fixture-template | ||
test-bitbucket-integration | ||
test-bump-initial-tag | ||
test-bump-initial-tag-cli-arg | ||
test-bump-initial-tag-default | ||
test-bump-unreleased-with-tag-message-arg | ||
test-bump-version | ||
test-bump-version-custom-minor | ||
test-bump-version-keep-zerover | ||
test-bump-version-major | ||
test-bump-version-minor | ||
test-bump-version-patch | ||
test-bumped-version | ||
test-cli-arg-ignore-tags | ||
test-commit-footers | ||
test-commit-preprocessors | ||
test-configure-from-cargo-toml | ||
test-custom-scope | ||
test-custom-tag-pattern | ||
test-date-order | ||
test-footer-filter | ||
test-footer-template | ||
test-from-context | ||
test-gitea-integration | ||
test-github-integration | ||
test-gitlab-integration | ||
test-header-template | ||
test-ignore-tags | ||
test-invert-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-no-exec | ||
test-regex-label-grouping | ||
test-regex-replace-parser | ||
test-skip-breaking-changes | ||
test-skip-commits | ||
test-split-commits | ||
test-tag-message | ||
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>