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

Check if changelog is modified based on type / breaking change #44

Open
epage opened this issue Oct 11, 2019 · 1 comment
Open

Check if changelog is modified based on type / breaking change #44

epage opened this issue Oct 11, 2019 · 1 comment
Labels
question Uncertainty is involved

Comments

@epage
Copy link
Collaborator

epage commented Oct 11, 2019

Use cases

  • A workspace might have multiple changelogs
  • We don't know how to map a commit to a changelog
  • Users might extend the list of changelogs
  • People might want to write changelog after-the-fact (like with clog or jilu)
  • People might want to write changelog at end of PR to summarize the work done (ie not a one to one mapping of commit to changelog change)
@epage epage added the question Uncertainty is involved label Oct 11, 2019
@epage
Copy link
Collaborator Author

epage commented Oct 11, 2019

Ideas

  • Config
    • Accept a glob of files so people can easily select one or all changelogs
    • Needs flag to control check for breaking changes
    • Needs a list of strings for types to check for
  • when to run
    • always
    • controllable on CLI with a default
    • Make default configurable?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Uncertainty is involved
Projects
None yet
Development

No branches or pull requests

1 participant