twisted / towncrier

Manage the release notes for your project.
https://towncrier.readthedocs.io
MIT License
755 stars 107 forks source link

Make consistent the expectation around non-existent fragments directory #557

Closed jaraco closed 8 months ago

jaraco commented 8 months ago

Description

In the first commit, I update the documentation to reflect the current behavior, highlighting that a missing fragments directory is normal for a "create" operation and caused by the "build" operation.

In the second commit, I expand the documentation to include the case where "build" is invoked and the fragments directory is missing to be consistent with an empty directory or no directory at all. I also draft a likely way to achieve this behavior. Once tests pass, this approach closes #538.

Note that this change aligns the behavior with the currently prescribed expectation.

Checklist

adiroiban commented 8 months ago

Thanks. Sorry for the extra trouble. I have merged it.

iliakur commented 8 months ago

@adiroiban you're gonna laugh, but I think we ran into this situation as well. I think we're gonna change our process for other reasons in a way that this isn't a problem. However, just in case, would you mind cutting a release with this in the next few days? Thanks a bunch!!

adiroiban commented 7 months ago

@iliakur here is the release PR https://github.com/twisted/towncrier/pull/566