Skip to content

v8.7.0

Choose a tag to compare

@kdeldycke kdeldycke released this 30 Jul 17:23
Immutable release. Only release title and notes can be modified.

Note

8.7.0 is available on 馃悕 PyPI and 馃悪 GitHub.

  • Add a <!-- mirror-src --> comment form of python:render :mirror:: the generator Python lives inside an HTML comment, so its output renders on GitHub and PyPI while the generator stays invisible.
  • Export update_blocks, marker_res, and a new replace_region helper from click_extra.sphinx for downstream self-updating documentation scripts.
  • Accept kebab-case keys in configuration files: dummy-flag and dummy_flag both address the --dummy-flag option, the last spelling winning on collision with a warning.
  • Scope the configuration strict check and merge to the app's own section, ignoring other tools' sections in shared files like pyproject.toml.
  • Honor legacy fallback_sections when merging configuration values into default_map, not only in the schema path.
  • Forward config_strict and additive excluded_params from @command/@group to the default --config option.
  • Load the configuration file before --params and --export-config render, so both reflect it whatever the order of the flags.
  • Export parameters without a value in --export-config: empty lists for multi-value options, null in YAML and JSON, commented-out keys in TOML.
  • Render --export-config keys in kebab-case, the canonical spelling for configuration files, matching the CLI flags.
  • Exclude --validate-config from configuration files, like the other self-referential config options.
  • Reword the unknown-configuration-key error, and report parameters blocked from configuration files as not allowed instead of unknown.
  • Fix DO_NOT_TRACK handling: a truthy value now forces --telemetry off; it previously fed the boolean flag verbatim and enabled telemetry.
  • Add an executables download table and a release-verification section to the installation guide.
  • Render the demo CLI help screen live in the installation guide, replacing captured output stuck on 7.2.0.
  • Add a CLI reference page rendering the command tree and the [tool.click-extra] configuration schema live.
  • Add cross-reference render tests asserting anchors and intersphinx links in the built documentation.

Full changelog: v8.6.3...v8.7.0