#towncrier — Public Fediverse posts

@river

Now that I have invested the time to build out the #towncrier configurations, and worked up the muscle memory, it's a tool that helps me be responsible to myself.

It helps me build towards what I want to see in "good" project documentation.

RIght now, I need these training wheels. YMMV.

Nice to finally put this project to bed today.

After much heel dragging on my part, I've gotten #towncrier installed into ~24 of my repos.

Now it's just going to be a part of my normal workflow.🎉

#TinyVictories #Python #CHANGELOG

Finally close to seeing the light at the end of the tunnel with my #towncrier adoption for my projects.

Only four more repo's(out of 20ish) git logs to audit and assemble plausible CHANGELOGs.

Did I _need_ to any of this work? No. No one is ever going to look at this.

Did I learn a few new things, or at least burn into muscle memory commands/workflows that will be useful in the future? Absolutely.

Glad that I put in the effort.

git tag -n
git tag -a <new_tag> <old_tag>^{}
git log -1 --format=%ai <tag>

#NoteToSelf #LessonsLearned #git #towncrier #CHANGELOG #python

Finally getting some traction on adopting #towncrier into my projects.

I've been dragging my heels for 6 months as auditing the git logs of ~20 4 year old projects has been terribly daunting/overwhelming.

Just going to have to be more diligent going forward with documenting changes.
Lesson learned.

It's not really "self-documenting" until you actually document it. derp.🤪

#Python #Changelog #documentation

Been playing around with #towncrier for the past couple of days.
I like its approach to creating & updating changelogs(plus its support for both .md & .rst output)

Between its clear tutorial and referencing pipx & pytest's usage of the package, I think it's going to be an easy add-on to my projects. Plus, I really need to get better disciplined at writing regular consistent #Changelog

https://towncrier.readthedocs.io/en/stable/tutorial.html

#Python

Finally released a new version 0.5.0a0 of `sphinxcontrib-towncrier` — my #Sphinx extension for injecting future draft/unreleased bits of Towncrier-managed change logs.

The main theme of this version is supporting Towncrier 24.7.0rc1 and higher.

#Python #Towncrier

Hoje é dia de Live de Python! \o/

Você já se perguntou como organizar e documentar as mudanças do seu código? 🤔

Hoje, conversaremos sobre changelogs, como eles ajudam a manter seu projeto organizado e como gerá-los facilmente com Towncrier!

Às 22h! 🔥

https://youtube.com/live/ATKJXpHrBfE

🔁🔁🔁

#python #towncrier #changelogs

i wrote this #python #cli #tool last year it's pretty good.

#protokolo generates a #changelog from fragment files, kind of like #towncrier, but way less intelligently (in a good way). its purpose is to circumvent the problem where many #vcs commits attempt to edit the same section in the change log file, and they #mergeConflict all the time. (or worse, a pr that is merged late adds its change log to a previous release.)

https://protokolo.readthedocs.io/en/stable/readme.html

#development #programming #git

Practically, I find it very helpful to write the change log item as an update to the change log document, included *as separately written documentation*, one change among others included in the same merge request.

Consider it like updating the API documentation in the same merge request that changes the API. Except here, the interface is for the humans considering whether and why to update to this version.

And a tool like #TownCrier https://towncrier.readthedocs.io/ can help a lot.

@xavdid @nedbat

I hate merge conflicts in my change logs.

I'm aware of #towncrier, but it's a bit finicky and prescriptive.

Is there another general-purpose #changelog generator, or is this something I'm going to end up writing myself?

I'm looking for something like #Scompler for Mastodon.

A tool that lets you schedule posts and analyze your interactions.

So far I've found and tried #Analytodon #Buffer #Fedilab #Fediplan #Scheduler #Seenly #Towncrier #Tweepsmap.

I made a quick table with the results of my tests: https://joinfediverse.wiki/Scheduling_and_analytic_tools_for_Mastodon

Does anybody know any other tools? Preferably something that ticks all the boxes?

Agreed @webaware, it is a clear sign that the release was made with no user-facing description of the changes.

If you don't already have the user-facing description of the change ready, it's not ready to commit to version control, and certainly not ready to release.

I like #TownCrier as a way to write a summary description of each change, committed along with the code change and assembled automatically into a user-facing change log document when it's time to release.

https://towncrier.readthedocs.io/