-
-
Notifications
You must be signed in to change notification settings - Fork 83
Open
Labels
area: documentationImprovements or additions to docsImprovements or additions to docsstatus: accepting prsPlease, send a pull request to resolve this!Please, send a pull request to resolve this!
Description
Documentation Report Checklist
- I have pulled the latest
main
branch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
I have scaffolded a new package using your template and got it working for the most part but noticed a few unclear steps in terms of the intended workflow and would like to know how to handle these as I haven't seen sufficient documentation on it.
- Creating the repository also sets up GitHub in an opinionated way, specifically disabling rebases and forcing everything to be squashed. As such anything that ends up in the
main
branch will always be a single commit, be it directly tomain
or via a PR. The release workflow therefore cannot pick up multiple changes at the same time, say two features. This is particularly relevant when I'm preparing a minor or even a major version release and wouldn't want all the separate changes be summarized under a single umbreallafeat
entry in the changelog and instead would like my users to actually see in detail what has changed. What's the recommended process to batch these changes for a single release? - In a similar fashion certain commits such as dependency updates don't trigger a release since they are prefixed with
chore
, especially when it's from renovate. What about the case where a critical vulnerability gets updated? This doesn't trigger a release and it seems I'd have to push an empty commit withfix
to trigger a release which really doesn't feel right. How am I supposed with the default setup to trigger a release after performing some more relevant dependency updates?
Additional Info
No response
JoshuaKGoldberg
Metadata
Metadata
Assignees
Labels
area: documentationImprovements or additions to docsImprovements or additions to docsstatus: accepting prsPlease, send a pull request to resolve this!Please, send a pull request to resolve this!