Fastlane setup improvements before release in CI automation #22191

mokagio · 2023-12-08T04:32:16Z

This does some tidy up before we add additional lanes and CI pipelines for release automation.

The main changes are:

Centralize the release branch name definition and check, which makes it handy to change the branch name for testing
Use one parameter only, skip_confirm to drive all the interactive settings of various commands. This way, CI can pass skip_confirm:true and run everything in non-interactive mode.

Regression Notes

Potential unintended areas of impact – Some of the release automation might have broken. As the release manager, I'll deal with if I run into it.
What I did to test those areas of impact (or what existing automated tests I relied on) – Run it on test branches.
What automated tests I added (or what prevented me from doing so) – N.A.

PR submission checklist:

I have completed the Regression Notes.
I have considered adding unit tests for my changes. N.A.
I have considered adding accessibility improvements for my changes. N.A.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary. N.A.

UI changes testing checklist: Not a UI PR.

This way it can be shared with the lanes for CI in the future and also easily hacked during testing.

mokagio · 2023-12-08T04:32:33Z

fastlane/Fastfile

-# Other defines used across multiple lanes
-REPOSITORY_NAME = 'WordPress-iOS'
-


Was unused.

mokagio · 2023-12-08T04:34:05Z

fastlane/Fastfile

+def compute_release_branch_name(options:, version: release_version_current)
+  branch_option = :branch
+  branch_name = options[branch_option]
+
+  if branch_name.nil?
+    branch_name = release_branch_name(version:)
+    UI.message("No branch given via option '#{branch_option}'. Defaulting to #{branch_name}.")
+  end
+
+  branch_name
+end


I moved this in Fastfile because it will be shared between lanes across files.

I don't remember why we need this computation logic over using the simpler interpolation from release_branch_name(version:).

I decided to roll with it instead of investigating to make faster progress with the release automation.

fastlane/lanes/release.rb

mokagio · 2023-12-08T04:40:31Z

fastlane/Fastfile

+def ensure_git_branch_is_release_branch
+  # Verify that the current branch is a release branch. Notice that `ensure_git_branch` expects a RegEx parameter
+  ensure_git_branch(branch: '^release/')
+end


I like this because I think the method name clearly explains what the method does, and we have moved the awkwardness with the explanation comment and RegExp input in a single, out of sight, place.

wpmobilebot · 2023-12-08T04:59:13Z

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

	App Name	Jetpack Alpha
	Configuration	Release-Alpha
	Build Number	pr22191-3cd2521
	Version	23.8
	Bundle ID	com.jetpack.alpha
	Commit	`3cd2521`
	App Center Build	jetpack-installable-builds #7100

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

wpmobilebot · 2023-12-08T05:23:47Z

	1 Warning
⚠️	PR is not assigned to a milestone.

Generated by 🚫 Danger

wpmobilebot · 2023-12-08T05:37:47Z

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

	App Name	WordPress Alpha
	Configuration	Release-Alpha
	Build Number	pr22191-3cd2521
	Version	23.8
	Bundle ID	org.wordpress.alpha
	Commit	`3cd2521`
	App Center Build	WPiOS - One-Offs #8080

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

mokagio · 2023-12-12T00:02:13Z

Adding @spencertransier as a reviewer since you're doing something similar in WooCommerce iOS, woocommerce/woocommerce-ios#11367 (which I haven't had a chance to comment upon yet)

oguzkocer

Looks great! I left a couple minor comments, but it's good to go as is

One of these comments is somewhat important (related to FL_GIT_BRANCH_DONT_USE_ENV_VARS) but it won't matter until we start doing releases in CI.

oguzkocer · 2023-12-12T18:56:09Z

fastlane/Fastfile

+
+def ensure_git_branch_is_release_branch
+  # Verify that the current branch is a release branch. Notice that `ensure_git_branch` expects a RegEx parameter
+  ensure_git_branch(branch: '^release/')


ensure_git_branch depends on environment variables, which means when we run the release automation in CI, the branch name it'll check is the one passed from Buildkite instead of the actual branch we are on. To avoid this, we need to add FL_GIT_BRANCH_DONT_USE_ENV_VARS env var as we do in WPAndroid.

Noted. I didn't run into this issue during my tests, #22194, but maybe it was due to some additional test setup...

However, this might explain something that surprised me and that I filed for investigation. In the screenshot below from this build the git_branch output is the branch the lane started on, not the new one.

Addressed in d9691c6

Yeap, that's the exact issue that environment variable addresses. If you'd like to learn more about it, here is the PR that we submitted to fastlane.

oguzkocer · 2023-12-12T18:57:49Z

fastlane/lanes/release.rb


    # Create the release branch
+    release_branch_name = compute_release_branch_name(options:, version: release_version_next)


It looks like we've already calculated the release_branch_name in line 25. (at the time of this comment)

Good catch! Thanks.

Address in fb1ddac

oguzkocer · 2023-12-12T19:03:10Z

fastlane/lanes/release.rb

+        • New internal release version and build code: #{release_version_next} (#{build_code_code_freeze_internal})
+      MESSAGE
+
+      UI.important(message)


How do you feel about always printing the message outside of the skip_user_confirmation check to make the information available in CI logs?

My rationale for only printing in interactive mode was that there's no point in showing that message if the user cannot act on it.

But.. your point of making information available in the CI logs is quite valid. Who knows, there might be a bug at some point in how the codes are evaluated, like it happened in #22087, at which point having logs might be a huge help in diagnosing.

Addressed in 2f8c867

oguzkocer · 2023-12-12T19:03:25Z

fastlane/lanes/release.rb

+        • New internal build code: #{build_code_next_internal}
+      MESSAGE
+
+      UI.important(message)


Similar to a previous comment, how do you feel about always printing the message outside of the skip_user_confirmation check to make the information available in CI logs?

oguzkocer · 2023-12-12T19:05:07Z

fastlane/lanes/release.rb

-      push_to_git_remote(tags: false)
-      trigger_beta_build
-    else
+    unless skip_user_confirmation || UI.confirm('Ready to push changes to remote and trigger the beta build?')
      UI.message('Aborting code freeze completion. See you later.')


I know this is not in the changeset, but this message feels a bit off to me. When we run this lane locally, the code freeze is completed at this point - we just didn't push it to remote yet.

It does make sense in CI, because if the change is not pushed, then it's discarded. However, that's not the case for local. 🤷

I see your point. I reworded it with something that is hopefully clearer in 919d62c. Open to suggestions in the upcoming PR.

mokagio · 2023-12-12T23:54:47Z

Thank you for the review @oguzkocer 🙇‍♂️

I'll merge this to move the project forward, but all your feedback is valuable and I'll address it in a followup PR.

See conversation at #22191 (comment)

mokagio added 11 commits December 8, 2023 14:50

Remove unused REPOSITORY_NAME const from Fastfile

fbdc705

Do not print code freeze preamble if user selected skip_confirm

b35fcbf

Use skip_confirm to also skip confirmation for push in code freeze

07812be

DRY release branch name definition in code freeze lane

2b90cbf

Exit code freeze lane without error when user aborts

6aedfa3

DRY skip confirmation controls in complete code freeze lane

ba5aff7

Use set_branch_protection over deprecated setbranchprotection

f7184fd

Abstract release branch check in ensure_git_branch_is_release_branch

87f061c

DRY release branch name definition and computation

e176d53

This way it can be shared with the lanes for CI in the future and also easily hacked during testing.

DRY skip confirmation controls in new beta lane

19979c3

Use skip_confirm to drive allow_retry in beta lint_localizations

661c4de

mokagio commented Dec 8, 2023

View reviewed changes

fastlane/lanes/release.rb Outdated Show resolved Hide resolved

Use DRYed branch name logic to create branch in code freeze automation

3cd2521

mokagio added the Tooling Build, Release, and Validation Tools label Dec 8, 2023

mokagio commented Dec 8, 2023

View reviewed changes

mokagio marked this pull request as ready for review December 8, 2023 05:17

mokagio mentioned this pull request Dec 8, 2023

Add automation to run most of the release flow in CI #22192

Merged

4 tasks

mokagio requested review from oguzkocer, crazytonyli and jkmassel December 8, 2023 05:32

mokagio added this to the 24.0 milestone Dec 11, 2023

mokagio requested a review from spencertransier December 12, 2023 00:02

oguzkocer approved these changes Dec 12, 2023

View reviewed changes

mokagio merged commit d6ec2c9 into trunk Dec 12, 2023
23 checks passed

mokagio deleted the mokagio/fastfile-improvements branch December 12, 2023 23:54

mokagio added a commit that referenced this pull request Dec 13, 2023

Always print version and build code change message

2f8c867

See conversation at #22191 (comment)

This was referenced Dec 13, 2023

Further Fastlane setup improvements before adding CI release automation #22214

Merged

CI: Add release pipelines woocommerce/woocommerce-ios#11367

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fastlane setup improvements before release in CI automation #22191

Fastlane setup improvements before release in CI automation #22191

mokagio commented Dec 8, 2023 •

edited

mokagio Dec 8, 2023

mokagio Dec 8, 2023

mokagio Dec 8, 2023

wpmobilebot commented Dec 8, 2023 •

edited

wpmobilebot commented Dec 8, 2023

wpmobilebot commented Dec 8, 2023

mokagio commented Dec 12, 2023

oguzkocer left a comment

oguzkocer Dec 12, 2023

mokagio Dec 13, 2023

oguzkocer Dec 13, 2023

oguzkocer Dec 12, 2023

mokagio Dec 13, 2023

oguzkocer Dec 12, 2023

mokagio Dec 13, 2023

oguzkocer Dec 12, 2023

oguzkocer Dec 12, 2023

mokagio Dec 13, 2023

mokagio commented Dec 12, 2023

		# Other defines used across multiple lanes
		REPOSITORY_NAME = 'WordPress-iOS'


		# Create the release branch
		release_branch_name = compute_release_branch_name(options:, version: release_version_next)

Fastlane setup improvements before release in CI automation #22191

Fastlane setup improvements before release in CI automation #22191

Conversation

mokagio commented Dec 8, 2023 • edited

Regression Notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wpmobilebot commented Dec 8, 2023 • edited

wpmobilebot commented Dec 8, 2023

wpmobilebot commented Dec 8, 2023

mokagio commented Dec 12, 2023

oguzkocer 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

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

mokagio commented Dec 12, 2023

mokagio commented Dec 8, 2023 •

edited

wpmobilebot commented Dec 8, 2023 •

edited