From 8a430ccc9102839e41b922ab5757ce2fbe539b22 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 18 Oct 2023 22:15:10 -0400 Subject: [PATCH] docs: --fail-if-warn and --check-links --- docs/commands.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/commands.rst b/docs/commands.rst index 3708878..6297ebb 100644 --- a/docs/commands.rst +++ b/docs/commands.rst @@ -208,6 +208,12 @@ correspond to a git tag. For example, this changelog entry with the title If there's no detectable version number in the header, or there isn't a git tag with the same number, then the entry can't be created as a GitHub release. +The ``--fail-if-warn`` option will end the command if a format conversion +generates a warning, usually because of a missing reference. The +``--check-links`` option will find the URLs in the release description, and +check if they are valid. Warnings are displayed for invalid URLs, but the +command still creates the release. + This command is independent of the other commands. It can be used with a hand-edited changelog file that wasn't created with scriv.