[Tooling] Add Release Publishing automation #12450

iangmaia · 2024-08-29T18:59:02Z

This PR automates the release publishing, which means to:

Publish the existing draft release on GitHub (which will also have GitHub create the associated git tag, pointing to the tip of the branch)
If the release branch for the next version already exists, backmerge the current release into it
Delete the current release branch

This PR will be followed by updates to the Releases V2 tool.

wpmobilebot · 2024-08-29T19:06:21Z

📲 You can test the changes from this Pull Request in WooCommerce-Wear Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce-Wear Android
	Platform	⌚️ Wear OS
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`f2a438e`
	Direct Download	`woocommerce-wear-prototype-build-pr12450-f2a438e.apk`

wpmobilebot · 2024-08-29T19:08:16Z

📲 You can test the changes from this Pull Request in WooCommerce Android by scanning the QR code below to install the corresponding build.

	App Name	WooCommerce Android
	Platform	📱 Mobile
	Flavor	Jalapeno
	Build Type	Debug
	Commit	`f2a438e`
	Direct Download	`woocommerce-prototype-build-pr12450-f2a438e.apk`

AliSoftware

Apart from the rename suggestion, LGTM.

Important

🎗️ We obviously need to wait for wordpress-mobile/release-toolkit#585 to land first and update this PR's Gemfile to the new version before we can land this PR

AliSoftware · 2024-08-30T17:11:55Z

fastlane/Fastfile

+  # @example Running the lane
+  #          bundle exec fastlane publish_release_and_cleanup skip_confirm:true
+  #
+  lane :publish_release_and_cleanup do |skip_confirm: false|


💭 I'm on the fence with the naming here.

On one hand I like the extra explicitness.
On the other hand, I like consistency, and our other apps (e.g. Tumblr iOS/Android and others) just call those lanes publish_release instead. And other lanes are not as descriptive in their names either (code_freeze, not code_freeze_then_trigger_new_beta 😅 )

So I'd say just call it publish_release instead?

Yeah, I started with publish_release, but realized this would clash with release-toolkit's publish_release.

Another option is to rename the action on release-toolkit -- perhaps something like publish_gh_release (but then we'd lose some consistency points with the action create_release 🤷 )?

Oh I see. Interesting.

Given some apps already use the name publish_release for their lanes, I'd have for us having to rename the lanes (and thus potentially update the ReleaseV2 scenarios accordingly for some of those?) when we adopt the new release-toolkit just because of the name clash.

So despite the inconsistency it'd introduce with create_release, I think I'd prefer for us to go with the action being renamed publish_gh_release in release-toolkit.

And actually, we could then take the occasion to rename create_release to create_gh_release (and potentially making create_release a deprecated alias for it, similar to how we did it when we renamed setbranchprotection to set_branch_protection in 9.4.0 before removing those backwards-compatibility-aliases in 10.0)?

And actually, we could then take the occasion to rename create_release to create_gh_release (and potentially making create_release a deprecated alias for it)

Great idea! Implemented on eb321aab9ef2a7e5c2116d5a1d4355fb625938ad

Great idea! Implemented on eb321aab9ef2a7e5c2116d5a1d4355fb625938ad

Glad to see this eventually became _github_ over _gh_. Clarity++ 👨‍🍳 💋

@AliSoftware @mokagio I've updated the PR after the release of release-toolkit 12.0.0.

mokagio

Looking good. Only nitpicks. Approving to unblock.

.buildkite/release-pipelines/publish-release.yml

mokagio · 2024-09-04T04:23:25Z

fastlane/Fastfile

+      - If the release branch for the next version `#{next_release_branch}` already exists, backmerge `#{current_branch}` into it
+      - If needed, backmerge `#{current_branch}` back into `#{DEFAULT_BRANCH}`
+      - Delete the `#{current_branch}` branch
+    PROMPT


I like PROMPT as the heredoc demarkation here 😄

fastlane/Fastfile

mokagio · 2024-09-04T04:29:47Z

fastlane/Fastfile

+
+    create_backmerge_pr
+
+    # Now that an eventual backmerge PR has created an intermediate branch, we can delete the `release/*` branch


I'm not sure I understand the "eventual" adjective here. It makes me think that the backmerge PR may or may not have been opened depending some factors, but looking at the code it seems that we'll always attempt it.

Yeah, the comment is referring to a hotfix/new version backmerge (which indeed might not happen if those don't exist), but indeed maybe it's better to clarify it.

Our create_release_backmerge_pull_request action skips creating a backmerge PR if the diff is empty (or more precisely if the HEAD and BASE are pointing to the same commit). So in theory it could happen that there's no backmerge PR created when you call create_release_backmerge_pull_request

In practice, we mostly call this action after having at least bumped the version file, which means there will always be a diff in those cases and thus a PR being created.

The only case I could think where this is not necessarily true is when we call create_release_backmerge_pull_request during publish_release (after the build has been approved by Google and we start rollout)

In most cases, at the time we publish_release on Mondays, there's nothing to backmerge again. The release/N branch has already been backmerged into trunk during finalize_release on Friday (after having done the final version bump and triggered the final build that was submitted for review) before the code freeze creating release/N+1. So at the time of publish_release, there's nothing new to backmerge and no PR to create

But in the rare case when we made new commits to release/N after code-freeze happened—e.g. the build was rejected by Google and we needed to do a fix in release/N on Monday and submit a new build for version N to address it—then we need to make sure that last-minute fix from release/N is propagated to release/N+1, and in such case the backmerge PR won't be empty and calling create_release_backmerge_pull_request at that state will create a PR.

So, yes, in 95% of cases create_release_backmerge_pull_request will create a backmerge PR. But in cases when we call it during publish_release on Monday while there hasn't been any new commit on release/N since finalize_release the Friday before, it should be smart enough to detect that the PR would be empty (as backmerge from Friday was already done and merged) and not create one at all in that case.

To be completely honest I'm not 100% sure our logic with point_to_same_commit? works as expected for the use case I mentioned above (because the commit from release/N would not be the same as the head commit from the target branch as the merge commit from previous backmerge PR would have happened in-between and that one would have a different SHA…?). But at least that was the initial intent (and even if it doesn't detect those cases as initially intended, if we manage to make create_release_backmerge_pull_request smarter in the future, it might avoid those unnecessary backmerge PRs when one has already happened and no new commit has landed in the source branch since)

dangermattic · 2024-09-04T11:12:49Z

	1 Warning
⚠️	This PR is assigned to the milestone 20.3. This milestone is due in less than 2 days. Please make sure to get it merged by then or assign it to a milestone with a later deadline.

Generated by 🚫 Danger

fastlane/Fastfile

… publishing

…lease` action call

Co-authored-by: Gio Lodi <[email protected]>

iangmaia · 2024-09-04T20:13:05Z

Note: I've added the commit dd12a80 using the new action name for creating a release, create_github_release.

mokagio · 2024-09-05T02:29:14Z

For the record, I toggled status: do not merge to verify the related Danger integration work and close a related request pdnsEh-1fv-p2

mokagio

Only a nitpick on the wording of the header doc

fastlane/Fastfile

Co-authored-by: Gio Lodi <[email protected]>

Base off woocommerce/woocommerce-android#12450

iangmaia added the category: tooling Anything that involves building & maintaining the project, including scripts, `Fastfile`, etc. label Aug 29, 2024

iangmaia requested a review from a team August 29, 2024 18:59

iangmaia self-assigned this Aug 29, 2024

iangmaia added this to the 20.3 milestone Aug 30, 2024

AliSoftware reviewed Aug 30, 2024

View reviewed changes

AliSoftware mentioned this pull request Aug 30, 2024

[Tooling] Add Release Publishing automation woocommerce/woocommerce-ios#13791

Merged

iangmaia force-pushed the iangmaia/automate-release-publishing branch from 8e9d219 to 64ba023 Compare September 3, 2024 19:48

mokagio approved these changes Sep 4, 2024

View reviewed changes

iangmaia commented Sep 4, 2024

View reviewed changes

fastlane/Fastfile Outdated Show resolved Hide resolved

dangermattic reviewed Sep 4, 2024

View reviewed changes

fastlane/Fastfile Outdated Show resolved Hide resolved

dangermattic reviewed Sep 4, 2024

View reviewed changes

fastlane/Fastfile Outdated Show resolved Hide resolved

iangmaia and others added 8 commits September 4, 2024 14:32

Temporarily use release-toolkit branch with shared action for release…

e3986bc

… publishing

Implement lane to automate release publishing

ef8b655

Add pipeline for release publishing

64bbe18

Update release-toolkit

f73f89f

Update lane to publish release and release-toolkit `publish_github_re…

8fcddd7

…lease` action call

Update backmerge PR error message

1180c17

Apply suggestions from code review

45909a4

Co-authored-by: Gio Lodi <[email protected]>

Update backmerge comment during release publishing

1a148b2

iangmaia force-pushed the iangmaia/automate-release-publishing branch from b05b0ba to 1a148b2 Compare September 4, 2024 12:33

Update call to create a Github release

dd12a80

mokagio added status: do not merge Dependent on another PR, ready for review but not ready for merge. and removed status: do not merge Dependent on another PR, ready for review but not ready for merge. labels Sep 5, 2024

mokagio approved these changes Sep 5, 2024

View reviewed changes

fastlane/Fastfile Outdated Show resolved Hide resolved

dangermattic reviewed Sep 5, 2024

View reviewed changes

fastlane/Fastfile Outdated Show resolved Hide resolved

dangermattic reviewed Sep 5, 2024

View reviewed changes

fastlane/Fastfile Outdated Show resolved Hide resolved

Publish also the Wear app release, if it's included

8b9c160

iangmaia force-pushed the iangmaia/automate-release-publishing branch from 2c35992 to 8b9c160 Compare September 5, 2024 14:34

Update publish_release lane comment

f2a438e

Co-authored-by: Gio Lodi <[email protected]>

iangmaia merged commit a915400 into trunk Sep 5, 2024
14 checks passed

iangmaia deleted the iangmaia/automate-release-publishing branch September 5, 2024 19:21

mokagio added a commit to Automattic/simplenote-android that referenced this pull request Sep 17, 2024

Add publish_release lane

1a5436c

Base off woocommerce/woocommerce-android#12450

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tooling] Add Release Publishing automation #12450

[Tooling] Add Release Publishing automation #12450

iangmaia commented Aug 29, 2024

wpmobilebot commented Aug 29, 2024 •

edited

Loading

wpmobilebot commented Aug 29, 2024 •

edited

Loading

AliSoftware left a comment

AliSoftware Aug 30, 2024

iangmaia Aug 30, 2024

AliSoftware Aug 30, 2024

iangmaia Sep 2, 2024 •

edited

Loading

mokagio Sep 2, 2024

iangmaia Sep 3, 2024

mokagio left a comment

mokagio Sep 4, 2024

mokagio Sep 4, 2024

iangmaia Sep 4, 2024

AliSoftware Sep 4, 2024

dangermattic commented Sep 4, 2024 •

edited

Loading

iangmaia commented Sep 4, 2024

mokagio commented Sep 5, 2024

mokagio left a comment


		create_backmerge_pr

		# Now that an eventual backmerge PR has created an intermediate branch, we can delete the `release/*` branch

[Tooling] Add Release Publishing automation #12450

[Tooling] Add Release Publishing automation #12450

Conversation

iangmaia commented Aug 29, 2024

wpmobilebot commented Aug 29, 2024 • edited Loading

wpmobilebot commented Aug 29, 2024 • edited Loading

AliSoftware left a 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

iangmaia Sep 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mokagio left a 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

dangermattic commented Sep 4, 2024 • edited Loading

iangmaia commented Sep 4, 2024

mokagio commented Sep 5, 2024

mokagio left a comment

Choose a reason for hiding this comment

wpmobilebot commented Aug 29, 2024 •

edited

Loading

wpmobilebot commented Aug 29, 2024 •

edited

Loading

iangmaia Sep 2, 2024 •

edited

Loading

dangermattic commented Sep 4, 2024 •

edited

Loading