Skip to content
Open
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
2 changes: 1 addition & 1 deletion .github/workflows/build-and-publish.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/check-release-tag.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions .github/workflows/checks.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/dependency-update.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/fast-tests.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/matrix.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .github/workflows/report.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion .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:
# Required for integration tests that call the GitHub CLI.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
strategy:
fail-fast: false
Expand All @@ -33,7 +34,7 @@ jobs:

- name: Set up Python & Poetry Environment
id: set-up-python-and-poetry-environment
uses: exasol/python-toolbox/.github/actions/python-environment@v8
uses: exasol/python-toolbox/.github/actions/python-environment@v10
with:
python-version: ${{ matrix.python_versions }}
poetry-version: "2.3.0"
Expand Down
7 changes: 7 additions & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Unreleased

## 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 and removed the unused developer-guide Modules section
1 change: 0 additions & 1 deletion doc/developer_guide/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@

../design
plugins
modules/modules
7 changes: 0 additions & 7 deletions doc/developer_guide/modules/modules.rst

This file was deleted.

14 changes: 0 additions & 14 deletions doc/developer_guide/modules/nox_tasks.rst

This file was deleted.

14 changes: 14 additions & 0 deletions doc/user_guide/features/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,17 @@ Important Nox Commands

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

The command :code:`nox -l` is the most reliable way to see the full current
session list for your project.

Common examples are:

* :code:`nox -s format:fix` to apply formatting changes
* :code:`nox -s project:check` to run the main local quality gate
* :code:`nox -s test:unit` to run unit tests
* :code:`nox -s workflow:generate -- all` to regenerate PTB workflows

Use the feature pages in this guide for task-specific details, for example
formatting, GitHub workflows, dependency management, release preparation, and
code-quality reporting.