Skip to content

Add Towncrier-based changelog system with GitHub release integration#870

Open
olamidepeterojo wants to merge 1 commit intofedora-infra:swatantryafrom
olamidepeterojo:towncrier
Open

Add Towncrier-based changelog system with GitHub release integration#870
olamidepeterojo wants to merge 1 commit intofedora-infra:swatantryafrom
olamidepeterojo:towncrier

Conversation

@olamidepeterojo
Copy link
Copy Markdown

Fixes #480

Signed-off-by: Olamide Ojo <peterojoolamide@gmail.com>
@gridhead gridhead requested a review from abompard March 31, 2026 05:55
@gridhead gridhead self-assigned this Mar 31, 2026
@gridhead gridhead added docs स्वातंत्र्य Fedora Badges Revamp Project cle Community Linux Engineering labels Mar 31, 2026
Copy link
Copy Markdown
Member

@gridhead gridhead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I would let @abompard review the functionality of the introduced changes, could you please limit the length of the commit messages to be under 50 characters?

@gridhead gridhead linked an issue Mar 31, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Member

@gridhead gridhead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rework this pull request based on the suggested changes and review the AI-Assisted Contributions Policy to disclose the use of AI tools.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you actually bother looking into the releases of the project? 1.0.0 dates back a couple of years, and it sure as heck did not come out on 21st March 2026 (i.e. its actual release date is 22nd April 2024).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had you spent some time with the codebase, you would have realised that there is a CHANGELOG.md file already that has been maintained since the version v0.2.0, which came out back on 13th March 2013.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review the distribution portion of the workflow file before delving into creating something in a similar line by yourself. This could have allowed you to contribute to other parts in a meaningful manner.

That is, of course, not to mention the time that I could have saved efforts by avoiding reviewing this change and thus putting it into some other pull request that actually is trying to make a useful change.

Comment on lines +28 to +29
with:
body_path: CHANGELOG.md No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would dump the entire file (which is, not to mention, already mistaken) into the most recently released version, instead of extracting parts that pertain to a specific release.

run: towncrier build --yes --version ${{ github.ref_name }}

- name: Create GitHub Release
uses: softprops/action-gh-release@v1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you check this line, the existing workflow already makes use of the more recent version of the action workflow, thus giving us one more reason as to why your changes do not help us.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes not only conflict with the existing changelog generation methods, but they also end up breaking them with a mistaken format and an incorrect location.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cle Community Linux Engineering docs स्वातंत्र्य Fedora Badges Revamp Project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use Towncrier for the changelog and convert it to Markdown

2 participants