From c16b6a7d43d8659154b11aed07d260c8239eae75 Mon Sep 17 00:00:00 2001 From: Manav Rathi Date: Fri, 12 Jul 2024 15:44:47 +0530 Subject: [PATCH] -rc => -beta to be clearer --- desktop/.github/workflows/desktop-release.yml | 4 +- desktop/docs/release.md | 44 +++++++++---------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/desktop/.github/workflows/desktop-release.yml b/desktop/.github/workflows/desktop-release.yml index e61bb6a7f0..c8fccdaf7f 100644 --- a/desktop/.github/workflows/desktop-release.yml +++ b/desktop/.github/workflows/desktop-release.yml @@ -17,8 +17,8 @@ on: # - cron: "45 2 * * 1-6" push: - # Run when a tag matching the pattern "vd.d.d"" is pushed. Crucially for - # us, this excludes the "-rc" tags. + # Run when a tag matching the pattern "vd.d.d" is pushed. In particular, + # this excludes the "-beta" tags. tags: - "v[0-9]+.[0-9]+.[0-9]+" diff --git a/desktop/docs/release.md b/desktop/docs/release.md index 83d0120551..07fc68ae10 100644 --- a/desktop/docs/release.md +++ b/desktop/docs/release.md @@ -18,20 +18,19 @@ to keep a separate repository just for holding the releases. - Releases are done from [ente-io/photos-desktop](https://github.com/ente-io/photos-desktop). -## Workflow - Release candidates +## Nightly builds -Nightly RC builds of `main` are published by a scheduled workflow automatically. -If needed, these builds can also be manually updated, and the branch of the -source repository to build (default "main") also specified: +Nightly builds of `main` are published by a scheduled workflow automatically. +Each such workflow run will update the artifacts attached to the same +(pre-existing) pre-release. + +If needed, this workflow can also be manually triggered: ```sh gh workflow run desktop-release.yml --source= ``` -Each such workflow run will update the artifacts attached to the same -(pre-existing) pre-release. - -## Workflow - Release +## Release checklist 1. Update source repo to set version `1.x.x` in `package.json` and finalize the CHANGELOG. @@ -50,37 +49,38 @@ Each such workflow run will update the artifacts attached to the same ``` This'll trigger the workflow and create a new pre-release. We can edit this to -add the release notes, convert it to a release. Once it is marked as latest, the -release goes live. +add the release notes, and convert it to a release. -We are done at this point, and can now update the other pre-release that hosts +Once it is marked as latest, the release goes live. + +We are done at this point, and can now update the other pre-release that'll hold subsequent nightly builds. -1. Update `package.json` in the source repo to use version `1.x.x-rc`, and +1. Update `package.json` in the source repo to use version `1.x.x-beta`, and merge these changes into `main`. 2. In the release repo, delete the existing _nightly_ pre-release, then: ```sh - git tag 1.x.x-rc - git push origin 1.x.x-rc + git tag 1.x.x-beta + git push origin 1.x.x-beta ``` 3. Start a new run of the workflow (`gh workflow run desktop-release.yml`). -Once the workflow finishes and the 1.x.x-rc pre-release is created, edit its -description to "Nightly builds". Subsequent scheduled nightly builds will update -this pre-release. +Once the workflow finishes and the 1.x.x-beta pre-release is created, edit its +description to "Nightly beta builds". Subsequent scheduled nightly workflows +will keep updating this pre-release. -## Workflow - Extra pre-releases +## Ad-hoc builds -To create extra one off pre-releases in addition to the nightly `1.x.x-rc` ones, +To create extra one-off pre-releases in addition to the nightly `1.x.x-beta`s, 1. In your branch in the source repository, set the version in `package.json` - to something different, say `1.x.x-my-test`. + to something different, say `1.x.x-foo`. -2. Create a new pre-release in the release repo with title `1.x.x-test`. In the - tag input enter `v1.x.x-test` and select the option to "create a new tag on +2. Create a new pre-release in the release repo with title `1.x.x-foo`. In the + tag input enter `v1.x.x-foo` and select the option to "Create a new tag on publish". 3. Trigger the workflow in the release repo: