Restructure and clean up GitHub release notes generator

[NotTheEvilOne]

What this PR does / why we need it:
This PR restructures and cleans up gardenlinux.github.release.

Which issue(s) this PR fixes:
Closes #189

Special notes for your reviewer:
Requires #335
Supersedes #332

[codecov]

Codecov Report

❌ Patch coverage is 93.39853% with 27 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.77%. Comparing base (35741dd) to head (a7de0f0).

Files with missing lines	Patch %	Lines
...enlinux/github/release/notes/markdown_generator.py	92.59%	10 Missing ⚠️
...denlinux/github/release/release_images_metadata.py	92.56%	9 Missing ⚠️
.../gardenlinux/github/release/deployment_platform.py	92.07%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #345      +/-   ##
==========================================
+ Coverage   91.29%   91.77%   +0.47%     
==========================================
  Files          51       46       -5     
  Lines        2954     2870      -84     
==========================================
- Hits         2697     2634      -63     
+ Misses        257      236      -21     

☔ 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.

[yeoldegrove]

make test does not work for me.

========================================================================================================================================================================================== ERRORS ==========================================================================================================================================================================================
______________________________________________________________________________________________________________________________________________________________________ ERROR collecting tests/github/test_release.py _______________________________________________________________________________________________________________________________________________________________________
ImportError while importing test module '/.../python-gardenlinux-lib/tests/github/test_release.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/nix/store/apzyghrw3m6iw69y7prw6jp2kbmsb8z2-python3-3.13.12-env/lib/python3.13/importlib/__init__.py:88: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tests/github/test_release.py:7: in <module>
    from ..constants import (
E   ImportError: cannot import name 'TEST_GARDENLINUX_RELEASE' from 'tests.constants' (/home/yeoldegrove/kunden/SAP/gardenlinux/python-gardenlinux-lib/tests/constants.py)
================================================================================================================================================================================= short test summary info ==================================================================================================================================================================================
ERROR tests/github/test_release.py

Also a dry-run is not working for me.

❯ gl-gh-release create-with-gl-release-notes --dry-run --owner gardenlinux --repo gardenlinux --tag 2150.3.0 --commit ddf3b2d84d972b6b6c7195d2ab726cdb84806e3a
Dry Run ...
This release would be created:
Traceback (most recent call last):
  File ".../python-gardenlinux-lib/.venv/bin/gl-gh-release", line 6, in <module>
    sys.exit(main())
             ~~~~^^
  File ".../python-gardenlinux-lib/src/gardenlinux/github/release/__main__.py", line 179, in main
    print(str(generator))
          ~~~^^^^^^^^^^^
  File ".../python-gardenlinux-lib/src/gardenlinux/github/release/notes/markdown_generator.py", line 222, in __str__
    published_images_table=self.release_images_table,
                           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File ".../python-gardenlinux-lib/src/gardenlinux/github/release/notes/markdown_generator.py", line 137, in release_images_table
    grouped_data = self._release_images_metadata.grouped_flavors_metadata
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File ".../python-gardenlinux-lib/src/gardenlinux/github/release/release_images_metadata.py", line 141, in grouped_flavors_metadata
    flavors = self.flavors_parser.filter(only_publish=True)
              ^^^^^^^^^^^^^^^^^^^
  File ".../python-gardenlinux-lib/src/gardenlinux/github/release/release_images_metadata.py", line 116, in flavors_parser
    repo = Repository.checkout_repo_sparse(
        tmpdir, ["flavors.yaml"], commit=self._commitish
    )
  File ".../python-gardenlinux-lib/src/gardenlinux/git/repository.py", line 171, in checkout_repo_sparse
    return Repository.checkout_repo(
           ~~~~~~~~~~~~~~~~~~~~~~~~^
        git_directory,
        ^^^^^^^^^^^^^^
    ...<4 lines>...
        logger=logger,
        ^^^^^^^^^^^^^^
    )
    ^
  File ".../python-gardenlinux-lib/src/gardenlinux/git/repository.py", line 138, in checkout_repo
    repo.remotes["origin"].fetch()
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
  File ".../python-gardenlinux-lib/.venv/lib/python3.13/site-packages/pygit2/remotes.py", line 245, in fetch
    payload.check_error(err)
    ~~~~~~~~~~~~~~~~~~~^^^^^
  File ".../python-gardenlinux-lib/.venv/lib/python3.13/site-packages/pygit2/callbacks.py", line 111, in check_error
    check_error(error_code)
    ~~~~~~~~~~~^^^^^^^^^^^^
  File ".../python-gardenlinux-lib/.venv/lib/python3.13/site-packages/pygit2/errors.py", line 67, in check_error
    raise GitError(message)
_pygit2.GitError: authentication required but no callback set

[NotTheEvilOne]

make test does not work for me.

========================================================================================================================================================================================== ERRORS ==========================================================================================================================================================================================
______________________________________________________________________________________________________________________________________________________________________ ERROR collecting tests/github/test_release.py _______________________________________________________________________________________________________________________________________________________________________
ImportError while importing test module '/.../python-gardenlinux-lib/tests/github/test_release.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/nix/store/apzyghrw3m6iw69y7prw6jp2kbmsb8z2-python3-3.13.12-env/lib/python3.13/importlib/__init__.py:88: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tests/github/test_release.py:7: in <module>
    from ..constants import (
E   ImportError: cannot import name 'TEST_GARDENLINUX_RELEASE' from 'tests.constants' (/.../python-gardenlinux-lib/tests/constants.py)
================================================================================================================================================================================= short test summary info ==================================================================================================================================================================================
ERROR tests/github/test_release.py

Merge conflict. Just fixed. Tests and linting should be successful again.

[yeoldegrove]

@

make test does not work for me.

========================================================================================================================================================================================== ERRORS ==========================================================================================================================================================================================
______________________________________________________________________________________________________________________________________________________________________ ERROR collecting tests/github/test_release.py _______________________________________________________________________________________________________________________________________________________________________
ImportError while importing test module '/.../python-gardenlinux-lib/tests/github/test_release.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/nix/store/apzyghrw3m6iw69y7prw6jp2kbmsb8z2-python3-3.13.12-env/lib/python3.13/importlib/__init__.py:88: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tests/github/test_release.py:7: in <module>
    from ..constants import (
E   ImportError: cannot import name 'TEST_GARDENLINUX_RELEASE' from 'tests.constants' (/.../python-gardenlinux-lib/tests/constants.py)
================================================================================================================================================================================= short test summary info ==================================================================================================================================================================================
ERROR tests/github/test_release.py

Merge conflict. Just fixed. Tests and linting should be successful again.

Now I get:

E       _pygit2.GitError: authentication required but no callback set

GITHUB_TOKEN env variable is set.

[NotTheEvilOne]

Now I get:

E       _pygit2.GitError: authentication required but no callback set

GITHUB_TOKEN env variable is set.

Interesting. Trying to reproduce :)

Edit: I've been unable to reproduce it including GITHUB_TOKEN="invalid" (and it's still working ;))

[NotTheEvilOne]

@yeoldegrove While I think you might run an unclean checkout I just updated poetry.lock to the latest compatible versions. Could you please give it another try (including poetry update for the sake of updating)?

[yeoldegrove]

@NotTheEvilOne I have the following in my ~/.config/git/config which is "pretty common" I guess.

[url "ssh://git@github.com/"]
    insteadOf = "https://github.com/"

This is picked up by pygit2 and publickey authentication is tried which fails internally.