Skip to content

Update changelog tool #2702

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update changelog tool #2702

wants to merge 5 commits into from

Conversation

JordonPhillips
Copy link
Contributor

This updates the changelog tool in a few small ways:

  • Existing staged entries have been removed
  • A pyproject.toml configuration was added to manage the python package.
  • The CLI script configurations were moved into the python package itself so that they can take advantage of linting / formatting tooling more easily.
  • Updated linters and formatters were run.
  • The README was updated to talk about the suggested build tool, uv.

One reason for the switch to uv is that it makes it easier to managae a virtual environment, particularly in the CI context. This means, for example, that we'll be able to more easily pull in PyGithub as an optional dependency instead of hand-rolling our own thing.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

This adds a python project config for the changelog tool, intended
to smooth over development a bit and enable us to share this later
if needed. This is intended to be used with uv.
This moves the changelog CLI scripts into the package itself. This
allows them to be used in the `pyproject`'s `scripts` table, which
then lets it be used by uv and other python tools. It also will make
it easier to share these later if we need to.
@JordonPhillips JordonPhillips requested a review from a team as a code owner July 15, 2025 14:54
@JordonPhillips JordonPhillips requested a review from yefrig July 15, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant