From 55f7b34e0718bd9b7867b3c3fdd42e3877056a88 Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 20:11:34 -0300 Subject: [PATCH 1/3] ux: clarify prepare release workflow inputs Signed-off-by: Vitor Mattos --- tests/test_prepare_release_template.py | 12 ++++++++++++ workflow-templates/prepare-release.yml | 16 ++++++++-------- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/tests/test_prepare_release_template.py b/tests/test_prepare_release_template.py index 65e70bf..483b661 100644 --- a/tests/test_prepare_release_template.py +++ b/tests/test_prepare_release_template.py @@ -29,6 +29,18 @@ def test_template_exposes_required_release_entry_points(self) -> None: self.assertIn("create_follow_up_milestone:", content) self.assertIn("mode:", content) + def test_dispatch_help_is_concise_and_explains_risky_inputs(self) -> None: + content = TEMPLATE.read_text(encoding="utf-8") + + self.assertNotIn("description: Optional", content) + self.assertIn("docs.libresign.coop/developer_manual/release-process/preparing.html", content) + self.assertIn("Leave blank to use the latest branch state", content) + self.assertIn("Branch and version rules are still validated", content) + self.assertIn("matching backport PR still open", content) + self.assertIn("move remaining open items", content) + self.assertIn("security keeps advisory-private details out of public release text", content) + self.assertIn("Never include private advisory details", content) + def test_template_delegates_all_release_stages_to_versioned_actions(self) -> None: content = TEMPLATE.read_text(encoding="utf-8") sha = "622599cc128ec55007b443d2908f78da930b8a21" diff --git a/workflow-templates/prepare-release.yml b/workflow-templates/prepare-release.yml index c7a31b2..bae2756 100644 --- a/workflow-templates/prepare-release.yml +++ b/workflow-templates/prepare-release.yml @@ -7,19 +7,19 @@ on: workflow_dispatch: inputs: branch: - description: Stable branch to release (for example stable35) + description: 'Stable branch to release, e.g. stable33. One branch per run. Guide: https://docs.libresign.coop/developer_manual/release-process/preparing.html' required: true type: string ref: - description: Optional exact commit/ref override + description: Exact commit or tag to plan instead of branch HEAD. Leave blank to use the latest branch state. required: false type: string version: - description: Optional explicit version override + description: Force a version instead of the calculated one. Branch and version rules are still validated. required: false type: string channel: - description: Release channel + description: final for a normal release; alpha, beta or rc for a prerelease. required: true default: final type: choice @@ -29,17 +29,17 @@ on: - rc - final ignore_open_backport: - description: Ignore an open backport blocker for this stable + description: Allow release with a matching backport PR still open. Use only after reviewing the blocker. required: true default: false type: boolean create_follow_up_milestone: - description: Create the next configured milestone + description: After release, create the next milestone and move remaining open items to it. required: true default: true type: boolean mode: - description: Release mode + description: normal for regular releases; security keeps advisory-private details out of public release text. required: true default: normal type: choice @@ -47,7 +47,7 @@ on: - normal - security safe_public_text: - description: Public-safe release text for security mode + description: Public wording used only in security mode. Never include private advisory details. required: false type: string pull_request: From c4a2bcbe388e222f23360fc0f11b6ab69bbb6496 Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 20:12:07 -0300 Subject: [PATCH 2/3] docs: use canonical release guide link Signed-off-by: Vitor Mattos --- workflow-templates/prepare-release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/workflow-templates/prepare-release.yml b/workflow-templates/prepare-release.yml index bae2756..8ccd851 100644 --- a/workflow-templates/prepare-release.yml +++ b/workflow-templates/prepare-release.yml @@ -7,7 +7,7 @@ on: workflow_dispatch: inputs: branch: - description: 'Stable branch to release, e.g. stable33. One branch per run. Guide: https://docs.libresign.coop/developer_manual/release-process/preparing.html' + description: 'Stable branch to release, e.g. stable33. One branch per run. Guide: https://github.com/LibreSign/documentation/blob/main/developer_manual/release-process/preparing.rst' required: true type: string ref: From a46810ab2b60fa6a117947bbbb9157cc4da99a3e Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Mon, 21 Sep 2026 20:12:12 -0300 Subject: [PATCH 3/3] test: assert canonical release guide link Signed-off-by: Vitor Mattos --- tests/test_prepare_release_template.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_prepare_release_template.py b/tests/test_prepare_release_template.py index 483b661..7f185fb 100644 --- a/tests/test_prepare_release_template.py +++ b/tests/test_prepare_release_template.py @@ -33,7 +33,7 @@ def test_dispatch_help_is_concise_and_explains_risky_inputs(self) -> None: content = TEMPLATE.read_text(encoding="utf-8") self.assertNotIn("description: Optional", content) - self.assertIn("docs.libresign.coop/developer_manual/release-process/preparing.html", content) + self.assertIn("github.com/LibreSign/documentation/blob/main/developer_manual/release-process/preparing.rst", content) self.assertIn("Leave blank to use the latest branch state", content) self.assertIn("Branch and version rules are still validated", content) self.assertIn("matching backport PR still open", content)