From ea61fe03ee2c40888eb39368bf7b41bf1108ab64 Mon Sep 17 00:00:00 2001 From: ammar Date: Mon, 23 Mar 2026 21:51:27 -0700 Subject: [PATCH] add recipe maintainers --- .gitea/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++ .gitignore | 1 + MAINTENANCE.md | 32 ++++++++++++++++++++++++++++++++ README.md | 8 ++++---- renovate.json | 3 +++ 5 files changed, 56 insertions(+), 4 deletions(-) create mode 100644 .gitea/PULL_REQUEST_TEMPLATE.md create mode 100644 MAINTENANCE.md diff --git a/.gitea/PULL_REQUEST_TEMPLATE.md b/.gitea/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..33100f8 --- /dev/null +++ b/.gitea/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +--- +name: "Shlink pull request template" +about: "Shlink pull request template" +--- + + + +* [ ] I have deployed and tested my changes +* [ ] I have [updated relevant versions in `abra.sh`](https://docs.coopcloud.tech/maintainers/upgrade/#updating-versions-in-the-abrash) +* [ ] I have made my environment variable changes [backwards compatible](https://docs.coopcloud.tech/maintainers/upgrade/#backwards-compatible-environment-variable-changes) +* [ ] I have added a [release note entry](https://docs.coopcloud.tech/maintainers/upgrade/#creating-new-release-notes) diff --git a/.gitignore b/.gitignore index 7a6353d..5d73654 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .envrc +*~ \ No newline at end of file diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 0000000..854f47e --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,32 @@ +# Shlink Recipe Maintenance + +All contributions should be made via a pull request. This is to ensure a +certain quality and consistency, that others can rely on. + +## Maintainer Responsibilities + +A recipe maintainer has the following responsibilities: + +- Respond to pull requests / issues within a week +- Make image security updates within a day +- Make image patch / minor updates within a week +- Make image major updates within a month + +In order to fullfill these responsibilities a recipe maintainer: + +- Has to watch the repository (to get notifications) +- Needs to make sure renovate is configured properly + +## Pull Requests + +A pull request can be merged if it is approved by at least one maintainer. For +pull requests opened by a maintainer they need to be approved by another +maintainer. Even though it is okay to merge a pull request with one approval, it +is always better if all maintainers looked at the pull request and approved it. + +## Become a maintainer + +Everyone can apply to be a recipe maintainer: +1. Watch the repository to always get updates +2. Simply add your self to the list in the [README.md](./README.md) and open a new pull request with the change. +3. Once the pull request gets merged you will be added to the [shlink maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/shlink-maintainers). diff --git a/README.md b/README.md index 5a9121c..e618a66 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # shlink -> One line description of the recipe +> Shlink is a self-hosted url shortner. * **Category**: Apps -* **Status**: 0 +* **Status**: 2 * **Image**: [`shlink`](https://hub.docker.com/r/shlink), 4, upstream * **Healthcheck**: No * **Backups**: No * **Email**: No * **Tests**: No * **SSO**: No -* **Maintainers**: RTM - POC: `@ammaratef45:matrix.org` +* **Maintainers**: [@Zigzagill](https://git.coopcloud.tech/Zigzagill), [@ammaratef45](https://git.coopcloud.tech/ammaratef45) @@ -29,4 +29,4 @@ For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech). The recipe will deploy a `console.` as well that you can use to manage and monitor short urls. -To do so, you will need an api-key, which you can create by using the `./bin/cli api-key:generate`. \ No newline at end of file +To do so, you will need an api-key, which you can create by using the `./bin/cli api-key:generate`. diff --git a/renovate.json b/renovate.json index 5db72dd..94a2d1f 100644 --- a/renovate.json +++ b/renovate.json @@ -2,5 +2,8 @@ "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": [ "config:recommended" + ], + "reviewers": [ + "team:shlink-maintainers" ] } -- 2.49.0