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
1 change: 1 addition & 0 deletions .github/workflows/slow-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ jobs:
permissions:
contents: read
env:
# Integration tests that use the GitHub CLI need this token.
Comment thread
ArBridgeman marked this conversation as resolved.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
strategy:
fail-fast: false
Expand Down
7 changes: 7 additions & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## Summary

This release documents how to discover and use PTB's Nox sessions in the user
guide and removes the unused Modules section from the developer guide.

## Documentation

* #456: Documented how to discover PTB nox sessions in the user guide

## Refactoring

* #934: Removed unused, experimental Nox session `lint:import`
2 changes: 1 addition & 1 deletion doc/github_actions/python_environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Example Usage
uses: actions/checkout@v7

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@v4
uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: 3.12
poetry-version: 2.3.0
Expand Down
15 changes: 13 additions & 2 deletions doc/user_guide/features/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,16 @@ Central files in regards to nox and the toolbox are:
Important Nox Commands
^^^^^^^^^^^^^^^^^^^^^^

* :code:`nox -l` shows a list of all available nox sessions
* :code:`nox -s <session>` run the specified session(s)

Use :code:`nox -l` to show the current list of sessions for your project

Common examples are as follows:

* :code:`nox -s format:fix` applies formatting changes.
* :code:`nox -s project:check` runs the main local quality gate.
* :code:`nox -s test:unit` runs unit tests.
* :code:`nox -s workflow:generate -- all` updates PTB workflow files.

For more details, see the feature pages in this guide. They include formatting,
GitHub workflows, dependency management, release preparation, and code-quality
reporting.