diff --git a/.github/workflows/slow-checks.yml b/.github/workflows/slow-checks.yml index fe561ceb7..39b148a74 100644 --- a/.github/workflows/slow-checks.yml +++ b/.github/workflows/slow-checks.yml @@ -20,6 +20,7 @@ jobs: permissions: contents: read env: + # Integration tests that use the GitHub CLI need this token. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} strategy: fail-fast: false diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index b377194ec..28ee15466 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -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` diff --git a/doc/github_actions/python_environment.rst b/doc/github_actions/python_environment.rst index fb3529847..4decb7379 100644 --- a/doc/github_actions/python_environment.rst +++ b/doc/github_actions/python_environment.rst @@ -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 diff --git a/doc/user_guide/features/index.rst b/doc/user_guide/features/index.rst index 373fb643b..5c91b6c67 100644 --- a/doc/user_guide/features/index.rst +++ b/doc/user_guide/features/index.rst @@ -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 ` 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.