stingray icon indicating copy to clipboard operation
stingray copied to clipboard

Published 20 hours ago • verified publisher icon StingraySoftware

Change to towncrier for changelog

Open matteobachetti opened this issue 3 years ago • 4 comments

Following Astropy, I would suggest to run changelog using towncrier. This seems like a foolproof way to avoid Changelog conflicts. It would be good to have towncrier integration and some Github action that checks the production of the change log.

matteobachetti avatar Apr 12 '21 11:04 matteobachetti

@jdswinbank I think we had a conversation about changelog at some point, but I can't find it. Was towncrier what you had proposed?

matteobachetti avatar Apr 12 '21 12:04 matteobachetti

Don't think it was me. At least, if it was, I've subsequently forgotten all about it and now deny everything. 😄

I have no hands-on experience with towncrier, but following Astropy's lead seems like a good idea.

jdswinbank avatar Apr 12 '21 12:04 jdswinbank

@matteobachetti if no one is working on this, I'll take this up.

I'm already working on DAVE'S docs, would be a good exercise to practice documentation

rachittshah avatar Apr 12 '21 13:04 rachittshah

The last commit here https://github.com/StingraySoftware/stingray/pull/657 is the initialization of using towncrier in stingray.

After doing some research, I have found these useful resources :

1)https://community.plone.org/t/using-towncrier-for-changes-rst-in-plone-packages/6486/7

  1. https://gist.github.com/mauritsvanrees/92c40bc16ceaf3c375d81c995b4552c4

mohamedmostafadawood avatar Apr 15 '22 23:04 mohamedmostafadawood