Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(config): add ignore_tags option #40

Merged
merged 5 commits into from
Dec 7, 2021
Merged

feat(config): add ignore_tags option #40

merged 5 commits into from
Dec 7, 2021

Conversation

kenji-miyake
Copy link
Contributor

@kenji-miyake kenji-miyake commented Dec 5, 2021

Resolves (#36)

Description

As discussed in #36, added ignore_tags option.

Motivation and Context

Sometimes users want to carry over commits instead of dropping them as skip_tags option does.

How Has This Been Tested?

Just tested in my local environment.

Although I tried to add tests in changelog.rs and integration_tests.rs, I thought it's impossible to test ignore_tags there.
I'd like to discuss in this PR a way to add automated tests.

Screenshots / Output (if appropriate):

$ git clone [email protected]:kenji-miyake/git-cliff.git
$ cd git-cliff
$ cargo run | tail -n 30
(omitted)
## [0.1.0-beta.2] - 2021-06-14

### Bug Fixes

- Install musl-tools for musl builds

$ git checkout add-ignore-tags
$ sd 'ignore_tags = ""' 'ignore_tags = "v0.1.0-beta.2"' config/cliff.toml
$ cargo run | tail -n 30
(omitted)
## [0.1.0-beta.3] - 2021-06-14

### Bug Fixes

- Install musl-tools for musl builds

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Resolves (#36)

Signed-off-by: Kenji Miyake <[email protected]>
@kenji-miyake kenji-miyake requested a review from orhun as a code owner December 5, 2021 11:48
@kenji-miyake
Copy link
Contributor Author

Tentatively, I've added a test using GitHub Actions. ee85a9b
@orhun Do you have any other ideas to test this?

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM! I just have a question and a few minor requests.

git-cliff/src/lib.rs Show resolved Hide resolved
config/cliff.toml Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@orhun
Copy link
Owner

orhun commented Dec 6, 2021

Tentatively, I've added a test using GitHub Actions. ee85a9b @orhun Do you have any other ideas to test this?

Absolutely liked this approach. I think we can leave it as is, just one suggestion: maybe rename the folder as fixtures and also rename the workflow to something like test-fixtures? I'm not sure though.

About the unit tests, I think I can work on that after merging the PR.

Kenji Miyake added 3 commits December 7, 2021 23:59
Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat implementation. Thank you!

@orhun orhun changed the title feat: add ignore_tags option feat(config): add ignore_tags option Dec 7, 2021
@orhun orhun merged commit de11cce into orhun:main Dec 7, 2021
@kenji-miyake kenji-miyake deleted the add-ignore-tags branch December 11, 2021 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants