Skip to content

docs: document automated release workflow - #96

Closed
vitormattos wants to merge 10 commits into
mainfrom
docs/release-automation
Closed

vitormattos wants to merge 10 commits into
mainfrom
docs/release-automation

Conversation

@vitormattos

@vitormattos vitormattos commented Sep 19, 2026

Copy link
Copy Markdown
Member

Summary

Documents the sequenced, CLI-driven release automation proposed in LibreSign/libresign#8447.

The release workflow files are now ordered explicitly:

  • release-00-tests.yml — Release 00 - Automation tests
  • release-10-prepare-pr.yml — Release 10 - Prepare release PR
  • release-20-finalize-preparation.yml — Release 20 - Finalize preparation
  • release-30-prepare-draft.yml — Release 30 - Prepare draft
  • release-40-publish-appstore.yml — Release 40 - Build, sign and publish App Store

The documentation explains that LibreSign-specific release logic lives in scripts/release/ behind the release.php CLI, while the YAML files primarily orchestrate actions and CLI commands.

It also documents:

  • dry-run release planning
  • automatic changelog and version preparation
  • milestone finalization and EOL handling
  • human review of the GitHub Release draft
  • the Nextcloud-derived final App Store publisher
  • PHPUnit tests for release rules and Git/GitHub command composition
  • actionlint + ShellCheck for LibreSign-owned release workflows
  • why act is useful for development but not authoritative

@vitormattos vitormattos changed the title docs: simplify release process around automated publication docs: document automated release workflow Sep 19, 2026

Copy link
Copy Markdown
Member Author

Release automation scope has now been consolidated in #97.

Before this documentation PR is considered final, the release guide should be aligned with that issue and the implemented workflow. In particular, avoid growing a single long page indefinitely: keep a short maintainer journey/overview and split detailed policy or manual recovery into focused developer pages when that improves navigation.

The public docs must describe both the normal GitHub Actions path and the equivalent manual/CLI procedure, and they must stay in the same development cycle as release behavior changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant