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

tools: Changelog to only accept specific categories #1168

Closed
wants to merge 1 commit into from

Conversation

orpheuslummis
Copy link
Contributor

Relevant issue(s)

Resolves #1167

Description

Have the changelog generation script to ignore all categories that are not in our specific list.

Question: How to relate to commits done by dependabot?
They can be categorized as deps or chore(TBD) or etc.
Then, either include them or ignore.

Note the options.filters was previously not used, as filters is actually only a subcategory of options.commits.

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
  • I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Manual run locally.

@orpheuslummis orpheuslummis added this to the DefraDB v0.5 milestone Mar 8, 2023
@orpheuslummis orpheuslummis requested a review from a team March 8, 2023 16:44
@orpheuslummis orpheuslummis self-assigned this Mar 8, 2023
@orpheuslummis orpheuslummis changed the title tools: Changelog accepting only specific categories tools: Changelog to only accept specific categories Mar 8, 2023
@AndrewSisley
Copy link
Contributor

Who doesn't love 'spacing as syntax'? 😆

Looks good to me and am happy with it, unless there is some odd time pressure on this I'd suggest letting it hang around for the others to comment first before merging though

@source-devs
Copy link

Benchmark Results

Summary

  • 0 Benchmarks successfully compared.
  • 0 Benchmarks were ✅ Better.
  • 0 Benchmarks were ❌ Worse .
  • 0 Benchmarks were ✨ Unchanged.
✅ See Better Results...
time/opdelta
 
❌ See Worse Results...
time/opdelta
 
✨ See Unchanged Results...
time/opdelta
 
🐋 See Full Results...

@orpheuslummis
Copy link
Contributor Author

I suggest that we can tag dependabot commits as deps(bot) and ignore them by default as they'd be outside of our list. We can do and include manual dependency updates by having them tagged as 'chore', for when that's relevant.

@orpheuslummis
Copy link
Contributor Author

Closing this PR in favor of just having one, #1165, and focusing it on making dependabot work (better) for the project

@orpheuslummis orpheuslummis deleted the orpheus/tools/changelog-filters branch April 17, 2023 20:10
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.

Changelog generation including all categories
3 participants