Add towncrier #220

mpnowacki-reef · 2023-11-18T12:43:41Z

No description provided.

mjurbanski-reef

I'm very happy this is happening, thank you :)

CHANGELOG.md

mjurbanski-reef · 2023-11-18T19:55:44Z

changelog.d/+towncrier.added.md

@@ -0,0 +1 @@
+Towncrier changelog generation - to avoid conflicts when simultaneously working on PRs


this should go into Infrastracture section not Added section, as this is something that should not affect end users in any case

you're right, I considered this a feature, but it is only one from a perspective of a developer

mjurbanski-reef · 2023-11-18T20:01:09Z

CONTRIBUTING.md

@@ -1,22 +1,58 @@
 # Contributing to B2 Command Line Tool

-We encourage outside contributors to perform changes to our codebase. Many such changes have been merged already. In order to make it easier to contribute, core developers of this project:
+We encourage outside contributors to perform changes to our codebase. Many such changes have been merged already. 


sembr

apparently readable formatter must be broken if it didn't catch lack of linebreak after period here.

It is worth investigating, as it very much may want to change the prefer list element character (*/-)

what is this formatter? is it anywhere in nox/CI?

oh, we don't have it here; nvm that then

still please put newline after . per sembr rules

noxfile.py

mjurbanski-reef · 2023-11-18T20:16:06Z

CONTRIBUTING.md

+4. deprecated
+5. removed
+6. infrastructure
+7. doc


IMO we shouldn't be inventing new sections if we are commiting to keepachangelog standard... we already added infrastracture, lets not add more. doc instead documentation feels weird as well...

I don't have that strong of a opinion here (i.e. I will be ok with whatever will be your finall call), but just letting you know it doesn't feel right to me.

quite a lot of stuff we do is about docs (like your last PR) I don't see a reason to not add sections we actually use since we have already diverted from keepachangelog

mjurbanski-reef · 2023-11-18T20:27:01Z

.github/workflows/ci.yml

-        with:
-          token: ${{ github.token }}
+      - name: Validate new changelog entries
+        run: if [ -z "$(git diff --diff-filter=A --name-only origin/${{ github.event.pull_request.base.ref }} changelog.d)" ];


this doesn't validate if new section added is an allowed section or not - even while testing I did a typo and this would certainly not catch it - I only realised when a file was leftover after changelog generation - and only after looking changelog.d myself, as towncrier build does not check if changelog.d is empty afterwards...

can't we use https://towncrier.readthedocs.io/en/stable/cli.html#towncrier-check here ?

I tried, check doesn't help that much either, unfortunately

we still need - this mistake is too easy to do and even during release we are very unlikely to catch it with

please follow up on this

towncrier check only detects typos in news types if:

Changelog is otherwise unedited; and

there is only one news item in the PR

not ideal, but still better than never I guess

mjurbanski-reef · 2023-11-18T20:30:31Z

pyproject.toml

+[[tool.towncrier.type]]
+directory = "infrastructure"
+name = "Infrastructure"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removed"
+name = "Removed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecated"
+name = "Deprecated"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "doc"
+name = "Doc"
+showcontent = true


please reorder these, from the MUST READ to "not that important" to the end user
i.e.
"Infrastructure" for sure should go at very end, and Removed/Changed (i.e. breaking changes) should go 1st and 2nd,

then Fixed, Deprecated, Added - but I don't feel as strongly about those.

README.release.md

mjurbanski-reef · 2023-11-18T20:42:45Z

CONTRIBUTING.md

+`towncrier create` also takes care of duplicates automatically (if there is more than 1 news fragment of one type 
+for a given github issue).


this sounds quite scary - can you lead me to documentation of this behavior?

https://towncrier.readthedocs.io/en/stable/cli.html#towncrier-create suggest new file will be created every time

you're there, in the paragraph you mentioned it says

f the filename exists already, towncrier create will add (and then increment) a number after the fragment type until it finds a filename that does not exist yet. In the above example, it will generate 123.bugfix.1.rst if 123.bugfix.rst already exists.

ah, ok, that is what you meant. I though you wanted to say it deduplicates things :) thx for clarifying it for me

mjurbanski-reef · 2023-11-19T19:29:11Z

.github/workflows/ci.yml

-        with:
-          token: ${{ github.token }}
+      - name: Validate new changelog entries
+        run: if [ -z "$(git diff --diff-filter=A --name-only origin/${{ github.event.pull_request.base.ref }} changelog.d)" ];


not ideal, but still better than never I guess

mpnowacki-reef force-pushed the towncrier branch 2 times, most recently from ea398a2 to 9c0d50e Compare November 18, 2023 12:48

mpnowacki-reef added 3 commits November 18, 2023 13:55

Add towncrier

ffd9b08

move existing news fragment to new convention

cb8d016

refactor CHANGELOG.md to adhere to new format

1f9bced

mpnowacki-reef force-pushed the towncrier branch from 9c0d50e to 1f9bced Compare November 18, 2023 13:01

mjurbanski-reef reviewed Nov 18, 2023

View reviewed changes

post review fixes

06b15b6

mjurbanski-reef approved these changes Nov 19, 2023

View reviewed changes

mpnowacki-reef closed this Nov 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add towncrier #220

Add towncrier #220

mpnowacki-reef commented Nov 18, 2023

mjurbanski-reef left a comment

mjurbanski-reef Nov 18, 2023

mpnowacki-reef Nov 18, 2023

mjurbanski-reef Nov 18, 2023

mpnowacki-reef Nov 18, 2023

mjurbanski-reef Nov 19, 2023

mjurbanski-reef Nov 18, 2023

mpnowacki-reef Nov 18, 2023

mjurbanski-reef Nov 18, 2023

mpnowacki-reef Nov 18, 2023 •

edited

Loading

mjurbanski-reef Nov 18, 2023

mpnowacki-reef Nov 18, 2023 •

edited

Loading

mjurbanski-reef Nov 19, 2023

mjurbanski-reef Nov 18, 2023

mjurbanski-reef Nov 18, 2023

mpnowacki-reef Nov 18, 2023

mjurbanski-reef Nov 18, 2023

mjurbanski-reef Nov 19, 2023

		@@ -0,0 +1 @@
		Towncrier changelog generation - to avoid conflicts when simultaneously working on PRs

		`towncrier create` also takes care of duplicates automatically (if there is more than 1 news fragment of one type
		for a given github issue).

Add towncrier #220

Add towncrier #220

Conversation

mpnowacki-reef commented Nov 18, 2023

mjurbanski-reef left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mpnowacki-reef Nov 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mpnowacki-reef Nov 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mpnowacki-reef Nov 18, 2023 •

edited

Loading

mpnowacki-reef Nov 18, 2023 •

edited

Loading