Skip to content

Add support to create pre-releases with a generated changelog #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
NotTheEvilOne wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support to create pre-releases with a generated changelog #271

NotTheEvilOne wants to merge 1 commit into from
+1,057 −390

Conversation

@NotTheEvilOne
Copy link
Contributor

@NotTheEvilOne NotTheEvilOne commented Dec 1, 2025

What this PR does / why we need it:
This PR enhances existing tooling to handle GitHub releases and adds support to generate a changelog for new releases of the python-gardenlinux-lib.

Which issue(s) this PR fixes:
Fixes #229
Fixes gardenlinux/gardenlinux#3800
Superseeds #210
Superseeds #230

@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 30 times, most recently from 82be326 to 5fe3ab4 Compare December 4, 2025 08:13
@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch from ff0db74 to 3c3061a Compare January 20, 2026 17:44
@NotTheEvilOne NotTheEvilOne marked this pull request as ready for review January 20, 2026 18:34
@NotTheEvilOne NotTheEvilOne requested a review from a team January 20, 2026 18:34
@NotTheEvilOne NotTheEvilOne self-assigned this Jan 20, 2026
@NotTheEvilOne NotTheEvilOne added the enhancement New feature or request label Jan 20, 2026
@NotTheEvilOne NotTheEvilOne added this to the 2026-01 milestone Jan 20, 2026
yeoldegrove
yeoldegrove requested changes Jan 21, 2026
View reviewed changes
Copy link
Contributor

@yeoldegrove yeoldegrove left a comment

Choose a reason for hiding this comment

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

Overall, nice work! See some nitpicks.
Also, we need some kind of written document how the release process works and how to push out a new release.

@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 2 times, most recently from 9817220 to 7c408ac Compare January 21, 2026 09:39
@NotTheEvilOne
Copy link
Contributor Author

NotTheEvilOne commented Jan 21, 2026

It would be great if this PR adds a written document on how (pre-)releases are created and which steps this includes.

Added with https://github.com/gardenlinux/python-gardenlinux-lib/blob/7c408ace805de2a8559fc31be2abbb6abd4d1ae9/docs/release.rst

@yeoldegrove
Copy link
Contributor

yeoldegrove commented Jan 21, 2026

It would be great if this PR adds a written document on how (pre-)releases are created and which steps this includes.

Added with https://github.com/gardenlinux/python-gardenlinux-lib/blob/7c408ace805de2a8559fc31be2abbb6abd4d1ae9/docs/release.rst

Could we extend this a bit so that it really also talks about the actual steps to be taken?

  • Bump Versions in which files and why?
    • e.g. :since: 0.7.0
    • pyproject.toml
    • .github/actions/*/*.yml
  • Command to do the tagging
  • How to use a new release in projects that consume the lib?

@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 5 times, most recently from 72ad30a to ab3b929 Compare January 24, 2026 19:27
@yeoldegrove yeoldegrove requested review from a team and vivus-ignis February 2, 2026 07:21
yeoldegrove
yeoldegrove approved these changes Feb 2, 2026
View reviewed changes
Copy link
Contributor

@yeoldegrove yeoldegrove left a comment

Choose a reason for hiding this comment

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

Thanks for the work.
I would vote for merging this and extending it in an iterative manner if needed.

@yeoldegrove yeoldegrove mentioned this pull request Feb 2, 2026
Open
@yeoldegrove yeoldegrove requested a review from a team February 3, 2026 08:33
vivus-ignis
vivus-ignis requested changes Feb 3, 2026
View reviewed changes
Copy link
Contributor

@vivus-ignis vivus-ignis left a comment

Choose a reason for hiding this comment

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

Minor corrections/questions. Otherwise: great work!

tests/github/test_release.py

release.tag = TEST_GARDENLINUX_RELEASE
release.commitish = TEST_GARDENLINUX_COMMIT
release.is_latest = (False,)
Copy link
Contributor

@vivus-ignis vivus-ignis Feb 3, 2026

Choose a reason for hiding this comment

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

I don't get why a tuple is needed here.

Copy link
Contributor Author

@NotTheEvilOne NotTheEvilOne Feb 3, 2026

Choose a reason for hiding this comment

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

/me too, this code is not touched by this PR.

Copy link
Contributor

@vivus-ignis vivus-ignis Feb 3, 2026

Choose a reason for hiding this comment

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

Then could we get rid of it? This line is confusing as if it has some importance for the actual test.

@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 5 times, most recently from 46b935c to dd9f12f Compare February 3, 2026 13:50
@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch from dd9f12f to ad4eb6f Compare February 3, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vivus-ignis vivus-ignis vivus-ignis requested changes

@yeoldegrove yeoldegrove yeoldegrove approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

@NotTheEvilOne NotTheEvilOne

Labels

enhancement New feature or request

Projects

None yet

Milestone

2026-01

Development

Successfully merging this pull request may close these issues.

Create CHANGELOG file

4 participants

@NotTheEvilOne @yeoldegrove @vivus-ignis