Skip to content

Conversation

@NotTheEvilOne
Copy link
Contributor

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 3 times, most recently from e1ad094 to 3dce024 Compare December 4, 2025 10:30
@NotTheEvilOne NotTheEvilOne mentioned this pull request Dec 4, 2025
@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 7 times, most recently from 03d9eff to eb60503 Compare December 10, 2025 16:01
@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 3 times, most recently from 4868f63 to 048350c Compare December 17, 2025 16:21
@codecov
Copy link

codecov bot commented Dec 17, 2025

Codecov Report

❌ Patch coverage is 88.61789% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.77%. Comparing base (95a3985) to head (7c408ac).

Files with missing lines Patch % Lines
src/gardenlinux/github/release/__main__.py 70.37% 8 Missing ⚠️
src/gardenlinux/github/release/release.py 92.42% 5 Missing ⚠️
src/gardenlinux/github/client.py 95.83% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #271      +/-   ##
==========================================
- Coverage   91.55%   90.77%   -0.78%     
==========================================
  Files          42       45       +3     
  Lines        2083     2201     +118     
==========================================
+ Hits         1907     1998      +91     
- Misses        176      203      +27     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch from 19e013d to 56af670 Compare December 20, 2025 13:36
@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch 3 times, most recently 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
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.

--name 'python-gardenlinux-lib v${{ steps.get-tag-name.outputs.tag-name }}' \
--latest \
--body "
$(git-cliff -o - --current)
Copy link
Contributor

Choose a reason for hiding this comment

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

These look really nice!

❯ git-cliff -o - --current
 WARN  git_cliff > "cliff.toml" is not found, using the default configuration
 WARN  git_cliff_core::changelog > 2 commit(s) were skipped due to parse error(s) (run with `-vv` for details)
## [0.10.8] - 2025-12-09

### 🐛 Bug Fixes

- Use local setup workflow for composite actions (#283)
- Pin 0.10.8 via tag

### 💼 Other

- *(deps)* Bump boto3 from 1.41.2 to 1.42.0 (#272)
- *(deps-dev)* Bump moto from 5.1.17 to 5.1.18 (#273)
- Pin all workflows to 0.10.8 commit hash (#282)

@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch from 3c3061a to 9817220 Compare January 21, 2026 09:24
Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: SAP <tobias.wolf@sap.com>
@NotTheEvilOne NotTheEvilOne force-pushed the feature/support-pre-release-changelog branch from 9817220 to 7c408ac Compare January 21, 2026 09:39
@NotTheEvilOne
Copy link
Contributor Author

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

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?

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create CHANGELOG file

3 participants