Skip to content
Merged
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
12 changes: 12 additions & 0 deletions tests/test_prepare_release_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -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("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)
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"
Expand Down
16 changes: 8 additions & 8 deletions workflow-templates/prepare-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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://github.com/LibreSign/documentation/blob/main/developer_manual/release-process/preparing.rst'
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
Expand All @@ -29,25 +29,25 @@ 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
options:
- 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:
Expand Down
Loading