beenull/ente
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[meta] Document the tag format, and call out the need to keep tag == title

Browse source 
Related: https://github.com/ente-io/ente/discussions/1087#discussioncomment-8775807
This commit is contained in:
Manav Rathi 2024-03-14 09:47:12 +05:30
parent 925133a297
commit 7fabb3a03c
No known key found for this signature in database
3 changed files with 51 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
auth/docs/release.md
View file

@ -1,7 +1,14 @@
# Releases # Releases
Create a PR to bump up the version in `pubspec.yaml`. Once that is merged, tag Create a PR to bump up the version in `pubspec.yaml`.
main, and push the tag.
> [!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 ```sh
git tag auth-v1.2.3 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. * Creates a new release in the internal track on Play Store.
Once the workflow completes, go to the draft GitHub release that was created. 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 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 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 from all the releases in the monorepo, so you'll need to filter them to keep

5
cli/docs/release.md
View file

@ -2,6 +2,11 @@
Tag main, and push the tag. 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 ```sh
git tag cli-v1.2.3 git tag cli-v1.2.3
git push origin cli-v1.2.3 git push origin cli-v1.2.3

32
mobile/docs/release.md Normal file
View file

@ -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.