rix/docs.coopcloud.tech
0
0
Fork 0
forked from toolshed/docs.coopcloud.tech
Code Issues Pull Requests Packages Projects Releases Wiki Activity

wip: docs: moar maintainer updates

Browse Source
This commit is contained in:
decentral1se
2025-12-29 23:05:44 +01:00
parent f268168cb9
commit 05b8c6ac26
2 changed files with 34 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/maintainers/maintain.md
View File

@ -20,9 +20,29 @@ If recipes are maintained by several maintainers, there is a greater chance of s
Anyone who deploys a recipe can become a recipe maintainer. If you want to ensure that a recipe becomes stable and reliable, then you can become the maintainer. If you maintain a recipe alone, ask for help and encourage others to join in. The only way we can reduce the endless workload of application updates is to coordinate our work together.
You can start by reading The Maintainers Proposal: [`R025`](https://docs.coopcloud.tech/federation/resolutions/passed/025/). Check if there are maintainers mentioned in the `README.md` of the recipe repository and if there is a `MAINTENANCE.md` present. For example, for the traefik recipe, here is [the list of maintainers in the `README.md`](https://git.coopcloud.tech/coop-cloud/traefik/src/commit/8eaee04b5d9980a99fdad57677a4c72d7796da10/README.md?display=source#L8) and the maintainers guidelines in the [`MAINTENANCE.md`](https://git.coopcloud.tech/coop-cloud/traefik/src/commit/8eaee04b5d9980a99fdad57677a4c72d7796da10/MAINTENANCE.md).
### `README.md` and `MAINTENANCE.md`
If there is no `MAINTENANCE.md`, copy the template below and create your own.
You can start by reading The Maintainers Proposal: [`R025`](https://docs.coopcloud.tech/federation/resolutions/passed/025/). Check if there are maintainers mentioned in the `README.md` of the recipe repository and if there is a `MAINTENANCE.md` present. For example, for the traefik recipe, here is [the list of maintainers in the `README.md`](https://git.coopcloud.tech/coop-cloud/traefik/src/commit/8eaee04b5d9980a99fdad57677a4c72d7796da10/README.md?display=source#L8) and the maintainers guidelines in the [`MAINTENANCE.md`](https://git.coopcloud.tech/coop-cloud/traefik/src/commit/8eaee04b5d9980a99fdad57677a4c72d7796da10/MAINTENANCE.md). If there is no `MAINTENANCE.md`, copy the template below and create your own.
### Maintainers Team
It is important that only recipe maintainers have write permissions to the repository. As it currently stands, every member of the [Co-operators Team](https://git.coopcloud.tech/org/coop-cloud/teams/co-operators) has write permissions to all recipe repositories for convenience while we are missing enough maintainers.
To change this, create a new team on [`git.coopcloud.tech/coop-cloud/teams`](https://git.coopcloud.tech/org/coop-cloud/teams) for your specific recipe, e.g. `mycoolrecipe-maintainers`. Add yourself and any other maintainers. Remove your recipe repository from the [list of repositories for the Co-operators Team](https://git.coopcloud.tech/org/coop-cloud/teams/co-operators/repositories) so that write permissions are removed.
### Repository Permissions
Under `Branch Protection` create a new rule for the `main` / `master` branch of
your repository. Add your maintainer team to the following list of permissions.
* Allow only maintainers to push directly to the main branch
* `Allowlist Restricted Push` > `Allowlisted teams for pushing`
* Allow only maintainers to approve pull requests
* `Restrict approvals to allowlisted users or teams` > `Allowlisted teams for reviews`
* Allow only maintainers to merge pull requests
* `Enable Merge Allowlist` > `Allowlisted teams for merging`
## Templates
### `MAINTENANCE.md` template

14
docs/maintainers/upgrade.md
View File

@ -1,5 +1,15 @@
---
title: How to Become a Recipe Maintainer
title: How to Upgrade a Recipe
---
## TODO
## Updating versions in the `abra.sh`
`#TODO`
## Backwards compatible environment variable changes
`#TODO`
## Creating new release notes
`#TODO`