Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .github/workflows/reusable-python-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ on:
type: boolean
secrets:
APP_ID:
description: ID of the GitHub App used to commit regenerated stubs
description: Client ID of the GitHub App used to commit regenerated stubs
required: false
APP_PRIVATE_KEY:
description: Private key of the GitHub App used to commit regenerated stubs
Expand All @@ -58,9 +58,6 @@ jobs:
name: 🚨 Lint
runs-on: ubuntu-26.04
timeout-minutes: 10
environment:
name: mqt-app
deployment: false
env:
APP_CONFIGURED: ${{ secrets.APP_ID != '' && secrets.APP_PRIVATE_KEY != '' }}
CMAKE_C_COMPILER_LAUNCHER: sccache
Expand Down
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,20 @@ releases may include breaking changes.

## [Unreleased]

## [2.5.0] - 2026-09-25

_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#250)._

### Added

- 🐍 Automatically commit outdated Python stubs with the MQT App when
`check-stubs` is enabled and App credentials are available ([#476])
([**@simon1hofmann**])

### Changed

- 👷 Upgrade Ubuntu runners to 26.04 ([#474]) ([**@denialhaag**])

## [2.4.2] - 2026-09-12

### Fixed
Expand Down Expand Up @@ -538,7 +546,8 @@ _📚 Refer to the [GitHub Release Notes] for previous changelogs._

<!-- Version links -->

[unreleased]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.4.2...HEAD
[unreleased]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.5.0...HEAD
[2.5.0]: https://github.com/munich-quantum-toolkit/workflows/releases/tag/v2.5.0
[2.4.2]: https://github.com/munich-quantum-toolkit/workflows/releases/tag/v2.4.2
[2.4.1]: https://github.com/munich-quantum-toolkit/workflows/releases/tag/v2.4.1
[2.4.0]: https://github.com/munich-quantum-toolkit/workflows/releases/tag/v2.4.0
Expand Down Expand Up @@ -588,6 +597,7 @@ _📚 Refer to the [GitHub Release Notes] for previous changelogs._
<!-- PR links -->

[#476]: https://github.com/munich-quantum-toolkit/workflows/pull/476
[#474]: https://github.com/munich-quantum-toolkit/workflows/pull/474
[#472]: https://github.com/munich-quantum-toolkit/workflows/pull/472
[#470]: https://github.com/munich-quantum-toolkit/workflows/pull/470
[#463]: https://github.com/munich-quantum-toolkit/workflows/pull/463
Expand Down
24 changes: 15 additions & 9 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@ of changes, including minor and patch releases, please refer to the

## [Unreleased]

## [2.5.0]

### Automatic Python stub updates

With `check-stubs: true`, the Python linter now fixes outdated `.pyi` files
under `python/` on same-repository PR branches other than the default branch.
The fix runs as a follow-up step in the linter job.
With `check-stubs: true`, the Python linter can now commit regenerated stubs
automatically. To enable this, forward the organization or repository secrets in
the job calling `reusable-python-linter.yml`:

```yaml
secrets:
APP_ID: ${{ secrets.APP_ID }}
APP_PRIVATE_KEY: ${{ secrets.APP_PRIVATE_KEY }}
```

Define `APP_ID` and `APP_PRIVATE_KEY` in the calling repository's `mqt-app`
environment, or pass them explicitly from the caller. Organization secrets
require forwarding. The App needs Contents write and Pull requests read access.
Without credentials, or for fork PRs, the check keeps the manual `nox -s stubs`
instructions.
Without these secrets, outdated stubs must still be regenerated and committed
manually.

## [2.4.0]

Expand Down Expand Up @@ -787,7 +792,8 @@ invocations under Windows.

<!-- Version links -->

[unreleased]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.4.0...HEAD
[unreleased]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.5.0...HEAD
[2.5.0]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.4.2...v2.5.0
[2.4.0]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.3.0...v2.4.0
[2.3.0]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.2.3...v2.3.0
[2.2.2]: https://github.com/munich-quantum-toolkit/workflows/compare/v2.2.1...v2.2.2
Expand Down
Loading