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

Allow sections to only include issues or pull requests #85

Closed
steven-sheehy opened this issue Mar 3, 2023 · 1 comment · May be fixed by #86
Closed

Allow sections to only include issues or pull requests #85

steven-sheehy opened this issue Mar 3, 2023 · 1 comment · May be fixed by #86

Comments

@steven-sheehy
Copy link
Contributor

steven-sheehy commented Mar 3, 2023

Problem

I target both issues and PRs to milestones, but I'd like to only include issues in the changelog. Having both in the changelog duplicates information and makes it harder to read. For Dependabot, there is no corresponding issue so I'd like to include both or just PRs for the dependencies section.

Solution

  • Add a changelog.sections[].type enum property with values ANY, ISSUE, or PULL_REQUEST
  • Default type property to ANY if not specified for backwards compatibility with existing configuration
  • Filter sections based upon property to only contain the requested issue type
@wilkinsona
Copy link
Contributor

Having both in the changelog duplicates information and makes it harder to read.

We avoid this problem by only having an issue or a pull request in a milestone for a particular change. In the spirit of that, I'll close this as superseded by #86.

@wilkinsona wilkinsona closed this as not planned Won't fix, can't repro, duplicate, stale Mar 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants