feat(release): change the prerelease logic #743

yj-yan · 2024-03-05T00:56:10Z

Please read CONTRIBUTING.md for additional information on contributing to this repository!

What this PR does / why we need it

Separate the pre-release and release jobs to allow main branch to release unstable and rc versions, and release branch for stable version.
Add a trigger_rc_release job and script to create release commit on main branch to trigger rc release when there are changes. This job could be configured to require manual approval.

Jira ID

Notes for your reviewers

swarmia · 2024-03-05T00:56:14Z

✅ Linked to Story DT-4238 · change logic for prerelease
➡️ Part of Epic DT-4126 · Improve release process for DT tooling and Stencil modules

getoutreach-ci-2 · 2024-03-05T20:13:22Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-2 · 2024-03-05T21:35:38Z

Link to code coverage report (posted by coverbot 🤖)

malept · 2024-03-05T22:33:07Z

orbs/shared/jobs/pre-release.yaml

+      condition: << parameters.dryrun >>
+      steps:
+        - run:
+            name: Pre-elease (Dry-run)


Nit:

Suggested change

name: Pre-elease (Dry-run)

name: Pre-release (dry run)

malept · 2024-03-05T22:57:25Z

orbs/shared/jobs/release.yaml

@@ -1,4 +1,4 @@
-description: Releases a new version of the application
+description: Pre-releases a new version of the application


question: isn't this a stable release?

Yes, this job is for stable release. Will correct the description in the pre-release job.

malept · 2024-03-05T23:01:50Z

shell/ci/release/pre-release.sh

+  # Read the GH_TOKEN from the file
+  GH_TOKEN="$(cat "$HOME/.outreach/github.token")"
+  if [[ -z $GH_TOKEN ]]; then
+    echo "Failed to read Github personal access token" >&2
+  fi


issue: according to this, ~/.outreach/github.token is the legacy path:

devbase/shell/ci/auth/github.sh

Lines 24 to 26 in 060fbed

# Configure the legacy path

mkdir -p "$HOME/.outreach"

echo "$GITHUB_TOKEN" >"$HOME/.outreach/github.token"

You should be using gh auth token, I believe.

Thanks, I updated to use gh auth token.

malept · 2024-03-05T23:03:43Z

shell/ci/release/trigger-rc-release.sh

+releaseUsername="Outreach CI"
+releaseUseremail="outreach-ci@outreach.io"


issue: perhaps the default values for this should be in the box config. We should avoid Outreach-specific values in this repo since it's public.

Good point, I've made it configurable from service.yaml. Will also add the default value in box config.

malept · 2024-03-05T23:04:24Z

shell/ci/release/dryrun.sh

@@ -44,6 +44,6 @@ fi

 GH_TOKEN="$GH_TOKEN" yarn --frozen-lockfile semantic-release --dry-run

-# Handle unstable releasing for CLIs, pre-conditions for this exist
+# Handle prerelease releasing for CLIs, pre-conditions for this exist


Nit:

Suggested change

# Handle prerelease releasing for CLIs, pre-conditions for this exist

# Handle prereleases for CLIs, pre-conditions for this exist

getoutreach-ci-1 · 2024-03-06T00:37:03Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-1 · 2024-03-06T00:50:36Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-2 · 2024-03-06T18:21:31Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-1 · 2024-03-06T19:55:07Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-1 · 2024-03-06T23:02:56Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-1 · 2024-03-26T20:30:18Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-1 · 2024-03-29T20:29:54Z

Link to code coverage report (posted by coverbot 🤖)

getoutreach-ci-2 · 2024-04-01T22:38:21Z

Link to code coverage report (posted by coverbot 🤖)

orbs/shared/jobs/trigger_rc_release.yaml

shell/ci/release/dryrun.sh

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

malept · 2024-04-24T20:52:42Z

Need to run make fmt as linting failed

yj-yan · 2024-04-24T21:05:18Z

Need to run make fmt as linting failed

Thanks, fixed the format.

getoutreach-ci-2 · 2024-04-30T17:10:04Z

🎉 This PR is included in version 2.27.0-rc.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

* fix(stencil): upgrade modules (2024-04-16) (#768) * fix(stencil): upgrade modules (2024-04-16) * Update .circleci/config.yml Co-authored-by: Mark Lee <malept@users.noreply.github.com> * Update package.json Co-authored-by: Mark Lee <malept@users.noreply.github.com> * update yarn.lock --------- Co-authored-by: getoutreach-ci-1[bot] <95656460+getoutreach-ci-1[bot]@users.noreply.github.com> Co-authored-by: Phil Brocker <5331286+pbr0ck3r@users.noreply.github.com> Co-authored-by: Mark Lee <malept@users.noreply.github.com> Co-authored-by: Devbase CI <phil.brocker@outreach.io> * chore: revert semantic-release dependency bumps (#769) * chore: add cortex.yaml (#770) * chore: add cortex.yaml * remove opslevel * fix(release-dryrun): CI-specific commands; use gh (#772) * fix(release-dryrun): only setup git user name/email in CI * refactor(release-dryrun): use gh for GitHub token * feat: add `make stencil` and `make restencil` (#771) * chore(deps): bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 (#773) Bumps [github.com/cloudflare/circl](https://github.com/cloudflare/circl) from 1.3.3 to 1.3.7. - [Release notes](https://github.com/cloudflare/circl/releases) - [Commits](cloudflare/circl@v1.3.3...v1.3.7) --- updated-dependencies: - dependency-name: github.com/cloudflare/circl dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: add catalog sync script, used when catalog manifest isn't a template (#774) * feat(coverbot): update version of coverbot to v1.0.5 (#775) * fix: bump kubeconform to 0.6.4 (#777) * fix: replace vulnerable, unmaintained dependency with a fixed, maintained fork (#779) * fix(go): parse HTTPS git URLs correctly (#780) * feat(release): change the prerelease logic (#743) * feat(release): change the prerelease logic * fix: typo * fix: linter * fix: remove testing lines * fix: add comments * fix: add script and orb to trigger rc release * fix: set branch to current if it is null * fix: comments and remove testing lines * fix: address comments * fix: force to trigger release for testing access token * fix: config release uer in service.yaml and default in box * fix: revert testing * fix: linter * fix: box config for release user * fix: use GH_TOKEN * fix: allow partial match the commit message * fix: skip release dryrun for empty change * use gh auth Co-authored-by: Mark Lee <malept@users.noreply.github.com> * update description Co-authored-by: Mark Lee <malept@users.noreply.github.com> * fix format --------- Co-authored-by: Devbase CI <devbase@outreach.io> Co-authored-by: Mark Lee <malept@users.noreply.github.com> * chore(deps): bump github.com/getoutreach/localizer from 1.15.3 to 1.15.4 (#778) * chore(deps): bump github.com/getoutreach/localizer from 1.15.3 to 1.15.4 Bumps [github.com/getoutreach/localizer](https://github.com/getoutreach/localizer) from 1.15.3 to 1.15.4. - [Release notes](https://github.com/getoutreach/localizer/releases) - [Changelog](https://github.com/getoutreach/localizer/blob/main/.releaserc.yaml) - [Commits](getoutreach/localizer@v1.15.3...v1.15.4) --- updated-dependencies: - dependency-name: github.com/getoutreach/localizer dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Restencil --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: --global <mark.lee@outreach.io> Co-authored-by: Mark Lee <malept@users.noreply.github.com> * fix(linters): prettier 3+ log level flag compatibility (#781) * fix: rc prerelease before unstable release (#783) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: getoutreach-ci-1[bot] <95656460+getoutreach-ci-1[bot]@users.noreply.github.com> Co-authored-by: Phil Brocker <5331286+pbr0ck3r@users.noreply.github.com> Co-authored-by: Mark Lee <malept@users.noreply.github.com> Co-authored-by: Devbase CI <phil.brocker@outreach.io> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jan Pecek <jan.pecek@outreach.io> Co-authored-by: Devbase CI <devbase@outreach.io> Co-authored-by: --global <mark.lee@outreach.io>

getoutreach-ci-1 · 2024-05-20T22:06:10Z

🎉 This PR is included in version 2.27.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

yj-yan force-pushed the yjyan/change-prerelease branch from 9b6a4f8 to 10da39a Compare March 5, 2024 21:33

yj-yan marked this pull request as ready for review March 5, 2024 21:36

yj-yan requested a review from a team as a code owner March 5, 2024 21:36

malept requested changes Mar 5, 2024

View reviewed changes

yj-yan requested a review from malept March 6, 2024 18:22

yj-yan added 15 commits March 29, 2024 13:26

feat(release): change the prerelease logic

d2efc0f

fix: typo

a865381

fix: linter

a470e69

fix: remove testing lines

88a598f

fix: add comments

35dee94

fix: add script and orb to trigger rc release

865b6e6

fix: set branch to current if it is null

76930f9

fix: comments and remove testing lines

1113b65

fix: address comments

a09ac16

fix: force to trigger release for testing access token

4a42d7b

fix: config release uer in service.yaml and default in box

ee735bc

fix: revert testing

0ef3639

fix: linter

60b4743

fix: box config for release user

19a79e0

fix: use GH_TOKEN

bdfec96

yj-yan force-pushed the yjyan/change-prerelease branch from 16f2098 to bdfec96 Compare March 29, 2024 20:27

yj-yan mentioned this pull request Apr 1, 2024

fix: test release workflow getoutreach/stencil-golang#466

Merged

fix: allow partial match the commit message

b61cb98

fix: skip release dryrun for empty change

66205ff

malept requested changes Apr 23, 2024

View reviewed changes

orbs/shared/jobs/trigger_rc_release.yaml Outdated Show resolved Hide resolved

shell/ci/release/dryrun.sh Outdated Show resolved Hide resolved

yj-yan and others added 3 commits April 24, 2024 11:27

use gh auth

e75ec63

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

update description

15f01c9

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

Merge branch 'main' into yjyan/change-prerelease

6216b6f

yj-yan requested a review from malept April 24, 2024 20:48

fix format

26b9cb0

malept approved these changes Apr 24, 2024

View reviewed changes

yj-yan merged commit b1e66aa into main Apr 24, 2024
4 checks passed

yj-yan deleted the yjyan/change-prerelease branch April 24, 2024 21:30

malept mentioned this pull request Apr 29, 2024

chore: restencil to use unstable devbase instead of a nonexistent branch getoutreach/stencil-golang#494

Merged

getoutreach-ci-2 bot added the released on @rc label Apr 30, 2024

getoutreach-ci-1 bot added the released label May 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(release): change the prerelease logic #743

feat(release): change the prerelease logic #743

yj-yan commented Mar 5, 2024 •

edited by jira bot

Loading

swarmia bot commented Mar 5, 2024 •

edited

Loading

getoutreach-ci-2 bot commented Mar 5, 2024

getoutreach-ci-2 bot commented Mar 5, 2024

malept Mar 5, 2024

malept Mar 5, 2024

yj-yan Mar 5, 2024

malept Mar 5, 2024

yj-yan Mar 6, 2024

malept Mar 5, 2024

yj-yan Mar 6, 2024

malept Mar 5, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-2 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 26, 2024

getoutreach-ci-1 bot commented Mar 29, 2024

getoutreach-ci-2 bot commented Apr 1, 2024

malept commented Apr 24, 2024

yj-yan commented Apr 24, 2024

getoutreach-ci-2 bot commented Apr 30, 2024

getoutreach-ci-1 bot commented May 20, 2024

		@@ -1,4 +1,4 @@
		description: Releases a new version of the application
		description: Pre-releases a new version of the application

	# Configure the legacy path
	mkdir -p "$HOME/.outreach"
	echo "$GITHUB_TOKEN" >"$HOME/.outreach/github.token"

		releaseUsername="Outreach CI"
		releaseUseremail="outreach-ci@outreach.io"

	# Handle prerelease releasing for CLIs, pre-conditions for this exist
	# Handle prereleases for CLIs, pre-conditions for this exist

feat(release): change the prerelease logic #743

feat(release): change the prerelease logic #743

Conversation

yj-yan commented Mar 5, 2024 • edited by jira bot Loading

What this PR does / why we need it

Jira ID

Notes for your reviewers

swarmia bot commented Mar 5, 2024 • edited Loading

getoutreach-ci-2 bot commented Mar 5, 2024

getoutreach-ci-2 bot commented Mar 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-2 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 6, 2024

getoutreach-ci-1 bot commented Mar 26, 2024

getoutreach-ci-1 bot commented Mar 29, 2024

getoutreach-ci-2 bot commented Apr 1, 2024

malept commented Apr 24, 2024

yj-yan commented Apr 24, 2024

getoutreach-ci-2 bot commented Apr 30, 2024

getoutreach-ci-1 bot commented May 20, 2024

yj-yan commented Mar 5, 2024 •

edited by jira bot

Loading

swarmia bot commented Mar 5, 2024 •

edited

Loading