Skip to content

Treat warnings as errors only on CI #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amotl merged 2 commits into from
Dec 23, 2025
Merged

Treat warnings as errors only on CI #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d808fe
Remove redundant `--jobs auto` definition
amotl Dec 23, 2025
956185a
Turn off treating warnings as errors in authoring mode using `-W`
amotl Dec 23, 2025
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
4 changes: 4 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Changes

Unreleased
==========
- Removed redundant ``--jobs auto`` definition
- Turned off treating warnings as errors in authoring mode using the
``-W`` option, only use it in CI workflows. This doesn't invalidate
the build cache, so cycles are much faster now. Thanks, @surister.

2.1.6 - 2025/12/23
==================
Expand Down
6 changes: 3 additions & 3 deletions common-build/rules.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ PYTHON = python3
PIP = $(PYTHON) -m pip
SPHINXBUILD = $(ENV_DIR)/bin/sphinx-build
SPHINXAUTOBUILD = $(ENV_DIR)/bin/sphinx-autobuild
AUTOBUILD_OPTS = --watch $(TOP_DIR) --re-ignore '^(?!.+\.(?:rst|md|mmd|html|css|js|py|conf)$$)' --open-browser --delay 0 --jobs auto
AUTOBUILD_OPTS = --watch $(TOP_DIR) --re-ignore '^(?!.+\.(?:rst|md|mmd|html|css|js|py|conf)$$)' --open-browser --delay 0
Copy link
Member Author

@amotl amotl Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a little fix where --jobs auto was defined redundantly: It is already defined per SPHINX_OPTS.

BUILD_DIR = $(LOCAL_DIR)/.build
SPHINX_ARGS = . $(BUILD_DIR)
SPHINX_OPTS = -W -n --jobs auto
SPHINX_OPTS_CI = --keep-going
SPHINX_OPTS = -n --jobs auto
SPHINX_OPTS_CI = -W --keep-going
Comment on lines -56 to +57
Copy link
Member Author

@amotl amotl Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This effectively switches the -W option to SPHINX_OPTS_CI, so it is no longer used in authoring mode.

RST2HTML = $(ENV_DIR)/bin/rst2html.py
TELEMETRY_DIR = $(LOCAL_DIR)/telemetry
VALE_VERSION = 2.6.7
Expand Down