Skip to content

Align towncrier with defaults#3960

Merged
jaraco merged 8 commits into
mainfrom
debt/towncrier-alignment
Jun 21, 2023
Merged

Align towncrier with defaults#3960
jaraco merged 8 commits into
mainfrom
debt/towncrier-alignment

Conversation

@jaraco

@jaraco jaraco commented Jun 21, 2023

Copy link
Copy Markdown
Member

As jaraco/skeleton is adopting towncrier, that upstream project is attempting to honor the default settings wherever possible.

These changes attempt to align with those defaults and re-use the functionality added upstream for managing towncrier.

Summary of changes

  • Move towncrier config to its own file.
  • Use the default 'newsfragments' for news fragments.
  • Use jaraco.develop.towncrier to check changes and determine the release kind.
  • Revert to towncrier default types.
  • Normalized headings in changelog.

@jaraco jaraco force-pushed the debt/towncrier-alignment branch 2 times, most recently from 256a399 to 8f00783 Compare June 21, 2023 12:33
@jaraco jaraco force-pushed the debt/towncrier-alignment branch from 8f00783 to 5f09e71 Compare June 21, 2023 12:49
@jaraco jaraco force-pushed the debt/towncrier-alignment branch from 5f09e71 to eec808a Compare June 21, 2023 14:03
@jaraco jaraco force-pushed the debt/towncrier-alignment branch from eec808a to 578480e Compare June 21, 2023 14:06
@jaraco

jaraco commented Jun 21, 2023

Copy link
Copy Markdown
Member Author

Tests are failing on cygwin because the new jaraco.develop dependency has some logic for uploading secrets to Github, which requires PyNaCl, which is built on CFFI, which cygwin doesn't support. We'll have to find a way to exclude that dependency.

@jaraco jaraco force-pushed the debt/towncrier-alignment branch from fccc3e3 to be206da Compare June 21, 2023 15:29
@jaraco

jaraco commented Jun 21, 2023

Copy link
Copy Markdown
Member Author

I'm going to push forward with merging this to unblock refreshing the skeleton. I welcome feedback, but for the most part, I expect this change to have minimal impact with one exception - existing PR changelogs will need to be updated:

  • change -> feature
  • breaking -> removal
  • misc -> bugfix (maybe)
  • The location may need to be updated (newsfragments/).

I'll help out with that this weekend.

@jaraco jaraco merged commit 7a72d55 into main Jun 21, 2023
@jaraco jaraco deleted the debt/towncrier-alignment branch June 21, 2023 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant