diff --git a/auth/docs/release.md b/auth/docs/release.md index 400ea6c2a..7ec7a7582 100644 --- a/auth/docs/release.md +++ b/auth/docs/release.md @@ -2,8 +2,8 @@ Create a PR to bump up the version number in `pubspec.yaml`. -Once that is merged, tag main and push the tag. This'll trigger a GitHub -workflow that: +Once that is merged, tag main (using the `auth-v1.2.3` format), and push the +tag. This'll trigger a GitHub workflow that: * Creates a new draft GitHub release and attaches all the build artifacts to it (mobile APKs and various desktop packages), @@ -20,7 +20,7 @@ go out). For more details, see the comments on top of the [auth-release workflow](.github/workflows/auth-release.yml). Once the workflow completes, go to the draft GitHub release it that was created. -Use the "Generate release notes", providing it the suitable tag if needed. The -release notes generated by default 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 auth. +Use the "Generate release notes" button after setting the "Previous tag" for the +last release of auth. 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 auth.