Skip to content

docs(config): Add scope-sorted example#16

Merged
orhun merged 1 commit intoorhun:mainfrom
FoxxMD:scopeSorted
Sep 21, 2021
Merged

docs(config): Add scope-sorted example#16
orhun merged 1 commit intoorhun:mainfrom
FoxxMD:scopeSorted

Conversation

@FoxxMD
Copy link
Copy Markdown
Contributor

@FoxxMD FoxxMD commented Sep 20, 2021

Description

Add an example configuration which details scope without grouping

  • Same as basic example but sorts commit by sorted scope
  • Defaults to "No Category" if no scope found on commit
  • Adds a nested bullet for breaking change description

Motivation and Context

When a changelog has few commits per scope (like 1 or 2) the scopes in the "grouped" example make the changelog very busy. It's easier to read when commits are only grouped by type type and instead prefixed with the scope.

Additionally, the regular scoped example config doesn't handle commits without a scope.

Screenshots / Output (if appropriate):

Example output from my project:

Details

Bug Fixes

  • (cache) Set actioned events not to expire in cache
  • (cache) Check manager has cache (valid config) before trying to get actioned events
  • (manager) Revert commented notification line from debugging
  • (recent) Deduplicate present subreddits
  • (No Category) Fix activity push to manager

Features

  • (attribution) Allow specifying aggregateOn filter when using domain blacklist
  • (cache) Refactor actioned events into cache for persistence and make number stored configurable
  • (history) Implement subreddit state and subreddit name parsing
    • BREAKING: include/exclude now filters POST activity window and all comparisons are done on those filtered activities against window activities
  • (message) Implement arbitrary message recipient to enable modmail

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.

@FoxxMD
docs(config): Add scope-sorted example
edc9edc 
* Same as basic example but sorts commit by sorted scope
* Defaults to "No Category" if no scope found on commit
* Adds a nested bullet for breaking change description
@FoxxMD FoxxMD requested a review from orhun as a code owner September 20, 2021 16:07
@FoxxMD
Copy link
Copy Markdown
Contributor Author

FoxxMD commented Sep 20, 2021

I wasn't sure how to generate the example output for README without typing it out by hand so I left the raw/rendered details blank...hoping you can easily fill it in :)

@orhun
Copy link
Copy Markdown
Owner

orhun commented Sep 21, 2021

This is awesome, thank you!

@orhun orhun merged commit 05584b6 into orhun:main Sep 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@orhun orhun Awaiting requested review from orhun orhun is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@FoxxMD @orhun