Further Fastlane setup improvements before adding CI release automation #22214

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

Follows up on @oguzkocer comments from the #22191 review, plus a few further refinements.

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) – N.A.
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.

As much as I like the informal tone, it was a one-off and therefore inconsistent with the rest of the automation messaging.

The "squiggly heredoc" allows to indent the content of an heredoc multiline string – good for code readability – without said indentation leaking into the printed string. See https://ruby-doc.org/core-2.5.0/doc/syntax/literals_rdoc.html#:~:text=To%20have%20indented%20content%20as%20well%20as%20an%20indented%20closing%20identifier%2C%20you%20can%20use%20a%20%E2%80%9Csquiggly%E2%80%9D%20heredoc%2C%20which%20uses%20a%20%E2%80%9C~%E2%80%9D%20instead%20of%20a%20%E2%80%9C%2D%E2%80%9D%20after%20%3C%3C%3A

See conversation at #22191 (comment)

mokagio · 2023-12-13T00:53:25Z

fastlane/lanes/release.rb

@@ -24,28 +24,25 @@

    release_branch_name = compute_release_branch_name(options:, version: release_version_next)

-    skip_user_confirmation = options[:skip_confirm]


As discussed here, #22191 (comment), reverted the change that printed this information only in user interactive (skip_confirm:false) mode.

mokagio · 2023-12-13T00:56:37Z

fastlane/lanes/release.rb

-      UI.message('Aborting code freeze as requested.')
+      UI.message("Terminating as requested. Don't forget to run the remainder of this automation manually.")


From #22191 (comment)

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. 🤷

Changed the verb to "terminating" which I hope removes the impression that the lane is atomic and therefore aborting would discard changes. Also added the second sentence to reinforce the fact that changes have been made and it's up to the user to complete the process.

I considered listing what the remaining steps were, but then decided against it to avoid having to maintain that list as the lane evolves.

I think this works OK as a generic message. Thanks for the improvement!

mokagio · 2023-12-13T00:58:05Z

fastlane/lanes/release.rb

+    message = <<~MESSAGE
+      Code Freeze:
+      • New release branch from #{DEFAULT_BRANCH}: #{release_branch_name}

-    unless skip_user_confirmation
-      # The `release_version_next` is used as the `new internal release version` value because the external and internal
-      # release versions are always the same.
-      message = <<-MESSAGE


I want to call out in this diff the move from <<- to <<~ and how it affects the indentation once message is printed.

cc @spencertransier as (I think) the original author. It's a neat Ruby feature I hope you'll enjoy.

oguzkocer

Looks great! I left a couple non-blocking suggestions.

fastlane/Fastfile

oguzkocer · 2023-12-13T16:42:20Z

fastlane/Fastfile

+# That means if we change the branch as part of an action, it'll return the incorrect branch.
+# This environment variable disables that behavior.
+# See https://github.com/fastlane/fastlane/pull/21597
+ENV['FL_GIT_BRANCH_DONT_USE_ENV_VARS'] = true


Nitpick but also a question. I thought environment variables can only be strings - or not set at all. I guess Ruby might be setting this as a string, I am not sure - but for those who are less familiar with Ruby (like myself) I think it's worth setting this as a string value instead.

Having said that, I might totally be wrong about environment variables, and if so, I'd like to fix that 😅

Nah, you are totally right. As the CI failure on this build shows, ENV expects the value passed to it to be a string.

I just assumed it was fine and that Ruby handled the conversion under the hood. My mistake. Thanks for noticing 🙇‍♂️

oguzkocer · 2023-12-13T16:43:50Z

fastlane/lanes/release.rb

-      UI.message('Aborting code freeze as requested.')
+      UI.message("Terminating as requested. Don't forget to run the remainder of this automation manually.")


I think this works OK as a generic message. Thanks for the improvement!

Co-authored-by: Oguz Kocer <oguzkocer@users.noreply.github.com>

That's just how Ruby works, and I should have known better...

wpmobilebot · 2023-12-14T01:01:06Z

📲 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	pr22214-42156ab
	Version	23.9
	Bundle ID	org.wordpress.alpha
	Commit	`42156ab`
	App Center Build	WPiOS - One-Offs #8127

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

wpmobilebot · 2023-12-14T01:04: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	pr22214-42156ab
	Version	23.9
	Bundle ID	com.jetpack.alpha
	Commit	`42156ab`
	App Center Build	jetpack-installable-builds #7147

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

mokagio added 7 commits December 13, 2023 10:58

Use remove_branch_protection in place of deprecated version

44ace2f

Set FL_GIT_BRANCH_DONT_USE_ENV_VARS in the environmet

d9691c6

Remove a duplicated release branch name computation

fb1ddac

Remove "See you later" from a couple of UI.message

e6a2f7d

As much as I like the informal tone, it was a one-off and therefore inconsistent with the rest of the automation messaging.

Replace "Aborting..." with messaging more in line with real behavior

919d62c

Always print version and build code change message

2f8c867

See conversation at #22191 (comment)

mokagio commented Dec 13, 2023

View reviewed changes

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

mokagio added this to the 24.0 milestone Dec 13, 2023

oguzkocer mentioned this pull request Dec 13, 2023

Merge 23.9 editorialized release notes to trunk wordpress-mobile/WordPress-Android#19781

Merged

oguzkocer approved these changes Dec 13, 2023

View reviewed changes

oguzkocer mentioned this pull request Dec 13, 2023

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

Merged

4 tasks

mokagio and others added 2 commits December 14, 2023 11:34

Fix a typo in a comment

24c1c40

Co-authored-by: Oguz Kocer <oguzkocer@users.noreply.github.com>

Pass a String to ENV assignment to avoid Fastlane crash

42156ab

That's just how Ruby works, and I should have known better...

mokagio enabled auto-merge December 14, 2023 00:38

mokagio merged commit 48de6b7 into trunk Dec 14, 2023
22 of 23 checks passed

mokagio deleted the mokagio/fastlane-improvements-followup branch December 14, 2023 01:27

mokagio mentioned this pull request Dec 14, 2023

Test branch for release automation in CI #22194

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Further Fastlane setup improvements before adding CI release automation #22214

Further Fastlane setup improvements before adding CI release automation #22214

mokagio commented Dec 13, 2023

mokagio Dec 13, 2023

mokagio Dec 13, 2023

oguzkocer Dec 13, 2023

mokagio Dec 13, 2023

oguzkocer left a comment

oguzkocer Dec 13, 2023

mokagio Dec 14, 2023 •

edited

oguzkocer Dec 13, 2023

wpmobilebot commented Dec 14, 2023

wpmobilebot commented Dec 14, 2023

		@@ -24,28 +24,25 @@

		release_branch_name = compute_release_branch_name(options:, version: release_version_next)

		skip_user_confirmation = options[:skip_confirm]

		UI.message('Aborting code freeze as requested.')
		UI.message("Terminating as requested. Don't forget to run the remainder of this automation manually.")

Further Fastlane setup improvements before adding CI release automation #22214

Further Fastlane setup improvements before adding CI release automation #22214

Conversation

mokagio commented Dec 13, 2023

Regression Notes

mokagio Dec 13, 2023

Choose a reason for hiding this comment

mokagio Dec 13, 2023

Choose a reason for hiding this comment

oguzkocer Dec 13, 2023

Choose a reason for hiding this comment

mokagio Dec 13, 2023

Choose a reason for hiding this comment

oguzkocer left a comment

Choose a reason for hiding this comment

oguzkocer Dec 13, 2023

Choose a reason for hiding this comment

mokagio Dec 14, 2023 • edited

Choose a reason for hiding this comment

oguzkocer Dec 13, 2023

Choose a reason for hiding this comment

wpmobilebot commented Dec 14, 2023

wpmobilebot commented Dec 14, 2023

mokagio Dec 14, 2023 •

edited