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
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:
# Required for integration tests that call the GitHub CLI.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
strategy:
fail-fast: false
Expand Down
6 changes: 6 additions & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

## 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
## Bug

* #909: Updated `cd.yml` workflow so that `cd-extension.yml` workflow depends on `build-and-publish`. This ensures that the custom release workflow only runs when the PyPi release was successful.
Expand Down
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.