Skip to content

docs: explain reusable release tooling for other Nextcloud apps #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vitormattos wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: explain reusable release tooling for other Nextcloud apps #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4704b7f
docs: expose reusable release tooling
vitormattos Sep 23, 2026
896af5a
docs: add reusable release tooling guide
vitormattos Sep 23, 2026
f662e86
docs: link GitHub App setup for external consumers
vitormattos Sep 23, 2026
a4c0d4b
docs: link GitHub App setup for adopters
vitormattos Sep 23, 2026
ad9408f
docs: streamline reusable release tooling guide
vitormattos Sep 23, 2026
ed5cf73
docs: keep release overview concise
vitormattos Sep 23, 2026
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
3 changes: 2 additions & 1 deletion developer_manual/release-process.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Release process

The normal LibreSign release path is driven from the **Prepare release** GitHub Actions workflow.

The reusable policy and contracts live in ``LibreCodeCoop/release-tool`` and orchestration lives in ``LibreCodeCoop/github-workflows``. ``LibreSign/libresign`` carries the consumer configuration and repository-specific packaging rules.
The reusable policy lives in ``LibreCodeCoop/release-tool`` and orchestration in ``LibreCodeCoop/github-workflows``. ``LibreSign/libresign`` supplies the consumer configuration and publisher.

Maintainer journey
------------------
Expand All @@ -27,6 +27,7 @@ There are only two semantic human release gates: merging the generated release P
.. toctree::
:maxdepth: 2

release-process/reusable-tooling
release-process/configuration
release-process/preparing
release-process/versioning
Expand Down
36 changes: 36 additions & 0 deletions developer_manual/release-process/reusable-tooling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. SPDX-FileCopyrightText: 2026 LibreCode coop and contributors
.. SPDX-License-Identifier: AGPL-3.0-or-later

Reusable release tooling
========================

LibreSign is the reference consumer of reusable release tooling:

``LibreCodeCoop/release-tool``
Release planning, version/changelog policy, state contracts, milestone transitions, history synchronization, draft generation and publication verification.

``LibreCodeCoop/github-workflows``
Tested GitHub Actions orchestration and managed workflow distribution.

``LibreSign/libresign``
Consumer configuration, stable branches, changelog/version files, packaging rules and publisher workflow.

Other Nextcloud apps can adopt the same tooling without depending on LibreSign application code.

Adopting it in another app
--------------------------

Use the generic guides maintained with the tooling:

* `Getting started <https://github.com/LibreCodeCoop/release-tool/blob/main/docs/getting-started.md>`_
* `Consumer configuration <https://github.com/LibreCodeCoop/release-tool/blob/main/docs/consumer-configuration.md>`_
* `Release lifecycle <https://github.com/LibreCodeCoop/release-tool/blob/main/docs/release-lifecycle.md>`_
* `GitHub Actions integration <https://github.com/LibreCodeCoop/release-tool/blob/main/docs/github-actions.md>`_
* `GitHub App setup <https://github.com/LibreCodeCoop/release-tool/blob/main/docs/github-app.md>`_
* `Managed workflow synchronization <https://github.com/LibreCodeCoop/github-workflows/blob/main/docs/cross-repository-automation.md>`_

A managed consumer installs ``prepare-release.yml`` and ``sync-workflow-templates.yml`` from the organization workflow catalog. The updater keeps installed workflows current through reviewable pull requests.

The release GitHub App needs Contents and Pull requests read/write access. A GitHub App used for workflow synchronization additionally needs Workflows write access.

The remaining pages in this section describe LibreSign's concrete release process. Generic configuration and GitHub App setup are intentionally not duplicated here.
Loading