From 7fabb3a03cbf58a35d95e2555bb768b50dd1a8b9 Mon Sep 17 00:00:00 2001
From: Manav Rathi <manav@mrmr.io>
Date: Thu, 14 Mar 2024 09:47:12 +0530
Subject: [PATCH] [meta] Document the tag format, and call out the need to keep
 tag == title

Related: https://github.com/ente-io/ente/discussions/1087#discussioncomment-8775807
---
 auth/docs/release.md   | 16 ++++++++++++++--
 cli/docs/release.md    |  5 +++++
 mobile/docs/release.md | 32 ++++++++++++++++++++++++++++++++
 3 files changed, 51 insertions(+), 2 deletions(-)
 create mode 100644 mobile/docs/release.md

diff --git a/auth/docs/release.md b/auth/docs/release.md
index afc80076a..4b31c72f0 100644
--- a/auth/docs/release.md
+++ b/auth/docs/release.md
@@ -1,7 +1,14 @@
 # Releases
 
-Create a PR to bump up the version in `pubspec.yaml`. Once that is merged, tag
-main, and push the tag.
+Create a PR to bump up the version in `pubspec.yaml`.
+
+> [!NOTE]
+>
+> Use [semver](https://semver.org/) for the tags, with `auth-` as a prefix.
+> Multiple beta releases for the same upcoming version can be done by adding
+> build metadata at the end, e.g. `auth-v1.2.3-beta+3`.
+
+Once that is merged, tag main, and push the tag.
 
 ```sh
 git tag auth-v1.2.3
@@ -16,6 +23,11 @@ This'll trigger a GitHub workflow that:
 * Creates a new release in the internal track on Play Store.
 
 Once the workflow completes, go to the draft GitHub release that was created.
+
+> [!NOTE]
+>
+> Keep the title of the release same as the tag.
+
 Set "Previous tag" to the last release of auth and press "Generate release
 notes". The generated release note will contain all PRs and new contributors
 from all the releases in the monorepo, so you'll need to filter them to keep
diff --git a/cli/docs/release.md b/cli/docs/release.md
index a539e7e5d..dce097eaf 100644
--- a/cli/docs/release.md
+++ b/cli/docs/release.md
@@ -2,6 +2,11 @@
 
 Tag main, and push the tag.
 
+> [!NOTE]
+>
+> See [auth/docs/release](../../auth/docs/release.md) for more details about the
+> tag format. The prefix for cli releases should be `cli-`.
+
 ```sh
 git tag cli-v1.2.3
 git push origin cli-v1.2.3
diff --git a/mobile/docs/release.md b/mobile/docs/release.md
new file mode 100644
index 000000000..c7b4f5081
--- /dev/null
+++ b/mobile/docs/release.md
@@ -0,0 +1,32 @@
+# Releases
+
+Create a PR to bump up the version in `pubspec.yaml`.
+
+> [!NOTE]
+>
+> Use [semver](https://semver.org/) for the tags, with `photos-` as a prefix.
+> Multiple beta releases for the same upcoming version can be done by adding
+> build metadata at the end, e.g. `photos-v1.2.3-beta+3`.
+
+Once that is merged, tag main, and push the tag.
+
+```sh
+git tag photos-v1.2.3
+git push origin photos-v1.2.3
+```
+
+This'll trigger a GitHub workflow that:
+
+* Creates a new draft GitHub release and attaches the build artifacts to it
+  (mobile APKs),
+
+Once the workflow completes, go to the draft GitHub release that was created.
+
+> [!NOTE]
+>
+> Keep the title of the release same as the tag.
+
+Set "Previous tag" to the last release of auth and press "Generate release
+notes". The generated release note will contain all PRs and new contributors
+from all the releases in the monorepo, so you'll need to filter them to keep
+only the things that relate to the Photos mobile app.