twisted / towncrier

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

Update the documentation for the release process. #558

Closed adiroiban closed 11 months ago

adiroiban commented 11 months ago

Description

Update the releaes process docs.

adiroiban commented 11 months ago

@webknjaz Let me know if the instruction make sense. I added a note about creating the discussion.


As for signing, I can look into it sometime, if there's any interest.

I think that signing would be great.

I didn't had time to check how this is done.

Right now, the PyPi packages are generated by GitHub Actions ... so no signing is involved.

If you want to see towncrier packages signed, feel free to send a PR. But only if you have time. Really :)

Much appreciated

adiroiban commented 11 months ago

Thanks for the review.

hynek commented 11 months ago

sorry for coming late, but I've been secretly doing the rst → md transformation of the releases and it's really easy so it might be worth adding?

The command line is pandoc --wrap=none --from rst --to gfm with stdin/stdout. So to simply transform the current clipboard:

(Linux & Windows untested)

adiroiban commented 11 months ago

I will keep this in mind for the next release, and we can update the docs.


Rather than doing pandoc, maybe it is worth also having a NEWS.md file

This can help as a showcase for MD support in towncrier.

I guess that in these days, MD is more popular than RST so we should consider .MD as first class format in towncrier

hynek commented 11 months ago

That's a great idea – there seems still to be the impression that Towncrier is rst-only.