Closed mokagio closed 1 year ago
dcalhoun
commented
1 year ago Also, a note for anyone else testing, the diff in the PR description did not apply for me. It failed with error: corrupt patch at line 365. Not sure why. I manually applied the changes. Below is an updated diff for testing convenience.
mokagio
commented
1 year ago @dcalhoun thank you for the review and sorry for the long time-to-reply.
🤔 I'm surprised by what you experienced, but it's possible I mangled the diff...
To be on the safe side, I pushed aafb0b2 (#142) which makes testing easier.
From the commit message:
Here, I tested it by using the following script:
#!/bin/bash -eu
source ./release_utils.sh
[[ -z $1 ]] && echo 'Need a path as argument' && exit 1
pushd "$1"
# Better to use a real commit, or the automation to update the repo will go in a fail-retry loop
update_ios_gutenberg_config 'Gutenberg/config.yml' 073c4a4d8d3239bd50029bc71097e54a30768821 test_repo
popdI called it like sh ./test.sh ../wordpress-ios and verified
Gutenberg/config.yml changed with
diff --git a/Gutenberg/config.yml b/Gutenberg/config.yml
index fdd93f7e0c..7b8861ff86 100644
--- a/Gutenberg/config.yml
+++ b/Gutenberg/config.yml
@@ -9,11 +9,6 @@
#
# LOCAL_GUTENBERG=../my-gutenberg-fork bundle exec pod install
ref:
- # This should have either a commit or tag key.
- # If both are set, tag will take precedence.
- #
- # We have automation that reads and updates this file.
- # Leaving commented keys is discouraged, because as the automation would ignore them and the resulting updates would be noisy
- tag: v1.102.0-alpha1
-github_org: wordpress-mobile
+ commit: 073c4a4d8d3239bd50029bc71097e54a30768821
+github_org: test_repo
repo_name: gutenberg-mobileNotice that the branch in the local copy of WordPress-iOS needs to be
mokagio/gutenberg-yaml-settings
mokagio
commented
1 year ago The iOS logic has been merged https://github.com/wordpress-mobile/WordPress-iOS/pull/21191. Merging this one now, too.
geriux
commented
1 year ago Hey @mokagio 👋 is it expected with these changes when running the script, to remove the comments within the ref value? For example in this release, the script https://github.com/wordpress-mobile/WordPress-iOS/pull/21476/commits/57d660760d97b5843dd17b698484ba52fa8475ce.
See discussion at https://github.com/wordpress-mobile/release-toolkit-gutenberg-mobile/pull/114#issuecomment-1543385142
Testing
Original instructions
Notice that these changes depend on https://github.com/wordpress-mobile/WordPress-iOS/pull/21191. To test them, either ensure that's been merged or checkout its branch. I hacked the rest of the script removing non-iOS related commands and run it locally to test it. The diff: ```diff diff --git a/release_automation.sh b/release_automation.sh index e427e24..60185e4 100755 --- a/release_automation.sh +++ b/release_automation.sh @@ -64,16 +64,6 @@ if ! [[ "$LOCAL_COMMIT" = "$DEFAULT_BRANCH_HEAD" ]]; then fi fi -# Check if script has uncommitted changes -if [ -n "$(git status --porcelain)" ]; then - echo "You are running this script with uncommitted changes." - echo "If you are generating a release you should generally use the current version of the script on the develop branch." - read -r -p "Are you sure you want the script to proceed? (y/n) " - echo "" - if ! [[ $REPLY =~ ^[Yy]$ ]]; then - abort "Exiting script..." - fi -fi # Read GB-Mobile PR template PR_TEMPLATE_PATH='./release_pull_request.md' @@ -91,264 +81,8 @@ if [[ ! "$GB_MOBILE_PATH" == *gutenberg-mobile ]]; then abort "Error path does not end with gutenberg-mobile" fi -source ./release_prechecks.sh "$GB_MOBILE_PATH" - -# Execute script commands from gutenberg-mobile directory -cd "$GB_MOBILE_PATH" - -# Check that Github CLI is installed -command -v gh >/dev/null || abort "Error: The Github CLI must be installed." - -# Check that Github CLI is logged -gh auth status >/dev/null 2>&1 || abort "Error: You are not logged into any GitHub hosts. Run 'gh auth login' to authenticate." - -# Check that jq is installed -command -v jq >/dev/null || abort "Error: jq must be installed." - -# Check that yq is installed -command -v yq >/dev/null || abort "Error: yq must be installed. On macOS, you can run: brew install yq." - -# Check that Aztec versions are set to release versions -aztec_version_problems="$(check_android_and_ios_aztec_versions)" -if [[ -n "$aztec_version_problems" ]]; then - warn "There appear to be problems with the Aztec versions:\n$aztec_version_problems" - confirm_to_proceed "Do you want to proceed with the release despite the ^above^ problem(s) with the Aztec version?" -else - ohai "Confirmed that Aztec Libraries are set to release versions. Proceeding..." -fi - -# Check if current HEAD is on trunk -CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD) -if [[ ! "$CURRENT_BRANCH" =~ ^trunk$ ]]; then - - # Check if current HEAD is a release tag - CURRENT_TAG=$(git tag --points-at HEAD) - if [[ ! "$CURRENT_TAG" =~ v[0-9]+\.[0-9]+\.[0-9]+ ]]; then - warn "Releases should generally only be based on 'trunk', or a release tag." - warn "Gutenberg-Mobile is currently on the '$CURRENT_BRANCH' branch and '$CURRENT_TAG' tag." - confirm_to_proceed "Are you sure you want to create a release branch from here?" - fi -fi - -# Confirm branch is clean -[[ -z "$(git status --porcelain)" ]] || { git status; abort "Uncommitted changes found. Aborting release script..."; } - -# Ask for new version number -CURRENT_VERSION_NUMBER=$(jq '.version' package.json --raw-output) -echo "Current Version Number:$CURRENT_VERSION_NUMBER" -read -r -p "Enter the new version number: " VERSION_NUMBER -if [[ -z "$VERSION_NUMBER" ]]; then - abort "Version number cannot be empty." -fi - -# Ensure javascript dependencies are up-to-date -read -r -p "Run 'npm ci' to ensure javascript dependencies are up-to-date? (y/n) " -n 1 -echo "" -if [[ $REPLY =~ ^[Yy]$ ]]; then - execute "npm" "ci" -fi - -# If there are any open PRs with a milestone matching the release version number, notify the user and ask them if they want to proceed -number_milestone_prs=$(check_if_version_has_pending_prs_for_milestone "$VERSION_NUMBER") -if [[ -n "$number_milestone_prs" ]] && [[ "0" != "$number_milestone_prs" ]]; then - echo "There are currently $number_milestone_prs PRs with a milestone matching $VERSION_NUMBER." - confirm_to_proceed "Do you want to proceed with cutting the release?" -fi - -# Create Git branch -RELEASE_BRANCH="release/$VERSION_NUMBER" -ohai "Create Git branch '$RELEASE_BRANCH' in gutenberg-mobile." -execute "git" "switch" "-c" "$RELEASE_BRANCH" - -# Create Git branch in Gutenberg -GB_RELEASE_BRANCH="rnmobile/release_$VERSION_NUMBER" -ohai "Create Git branch '$GB_RELEASE_BRANCH' in gutenberg." -cd gutenberg -execute "git" "switch" "-c" "$GB_RELEASE_BRANCH" -cd .. - -# Set version numbers -ohai "Set version numbers in package.json files" -for file in 'package.json' 'package-lock.json' 'gutenberg/packages/react-native-aztec/package.json' 'gutenberg/packages/react-native-bridge/package.json' 'gutenberg/packages/react-native-editor/package.json'; do - TEMP_FILE=$(mktemp) - execute "jq" ".version = \"$VERSION_NUMBER\"" "$file" > "$TEMP_FILE" "--tab" - execute "mv" "$TEMP_FILE" "$file" -done - -# Commit react-native-aztec, react-native-bridge, react-native-editor version update -ohai "Commit react-native-aztec, react-native-bridge, react-native-editor version update version update" -cd gutenberg -git add 'packages/react-native-aztec/package.json' 'packages/react-native-bridge/package.json' 'packages/react-native-editor/package.json' -execute "git" "commit" "-m" "Release script: Update react-native-editor version to $VERSION_NUMBER" -cd .. - -# Commit gutenberg-mobile version updates -ohai "Commit gutenberg-mobile version updates" -git add 'package.json' 'package-lock.json' -execute "git" "commit" "-m" "Release script: Update gb mobile version to $VERSION_NUMBER" - -# Make sure podfile is updated -ohai "Make sure podfile is updated" -PRE_IOS_COMMAND="npm run core preios" -eval "$PRE_IOS_COMMAND" - -# If preios results in changes, commit them -cd gutenberg -if [[ -n "$(git status --porcelain)" ]]; then - ohai "Commit changes from '$PRE_IOS_COMMAND'" - execute "git" "commit" "-a" "-m" "Release script: Update with changes from '$PRE_IOS_COMMAND'" -else - ohai "There were no changes from '$PRE_IOS_COMMAND' to be committed." -fi -cd .. - -# Ask if a cherry-pick is needed before bundling (for example if this is a hotfix release) -cd gutenberg -CHERRY_PICK_PROMPT="Do you want to cherry-pick a commit from gutenberg? (y/n) " -while - read -r -p "$CHERRY_PICK_PROMPT" -n 1 - echo "" - [[ $REPLY =~ ^[Yy]$ ]] -do - read -r -p "Enter the commit hash to cherry-pick: " GUTENBERG_COMMIT_HASH_TO_CHERRY_PICK - execute "git" "cherry-pick" "$GUTENBERG_COMMIT_HASH_TO_CHERRY_PICK" - CHERRY_PICK_PROMPT="Do you want to cherry-pick another commit from gutenberg? (y/n) " -done -cd .. - -# Commit updates to gutenberg submodule -ohai "Commit updates to gutenberg submodule" -execute "git" "add" "gutenberg" -execute "git" "commit" "-m" "Release script: Update gutenberg ref" - -# Update the bundles -ohai "Update the bundles" -npm run bundle || abort "Error: 'npm bundle' failed.\nIf there is an error stating something like \"Command 'bundle' unrecognized.\" above, perhaps try running 'rm -rf node_modules gutenberg/node_modules && npm ci'." - -# Commit bundle changes -ohai "Commit bundle changes" -execute "git" "add" "bundle/" -execute "git" "commit" "-m" "Release script: Update bundle for: $VERSION_NUMBER" - -# Update the Podfile for the XCFramework builder project -# -# We use a dedicated Xcode project to build the iOS distribution XCFramework which uses CocoaPods to fetch React Native dependencies and which references the project version. -# It's necessary to keep the versions up to day in the project's lockfile. -ohai 'Update XCFramework builders project Podfile.lock' -cd ios-xcframework -execute 'bundle' 'install' -execute 'bundle' 'exec' 'pod' 'install' -# It is expected for Podfile.lock to change when the version changes in the project. -# Therefore, we don't conditionally stage and commit, as not having changes should be considerd a failure. -execute 'git' 'add' 'Podfile.lock' -execute 'git' 'commit' '-m' "Release script: Sync XCFramework \`Podfile.lock\` with $VERSION_NUMBER" -cd .. - -##### -# Create PRs -##### - -# Verify before creating PRs -confirm_to_proceed "Do you want to proceed with creating a Gutenberg-Mobile PR for the $RELEASE_BRANCH branch and a Gutenberg PR for the $GB_RELEASE_BRANCH branch." -ohai "Proceeding to create PRs..." - -##### -# Gutenberg-Mobile PR -##### - -# Replace version number in GB-Mobile PR template -PR_BODY=${PR_TEMPLATE//v1.XX.Y/$VERSION_NUMBER} - -execute "git" "push" "-u" "origin" "HEAD" - -# Create Draft GB-Mobile Release PR in GitHub -GB_MOBILE_PR_URL=$(execute "gh" "pr" "create" \ -"--title" "Release $VERSION_NUMBER" \ -"--body" "$PR_BODY" \ -"--repo" "$MOBILE_REPO/gutenberg-mobile" \ -"--head" "$MOBILE_REPO:$RELEASE_BRANCH" \ -"--base" "$GUTENBERG_MOBILE_TARGET_BRANCH" \ -"--label" "$GUTENBERG_MOBILE_PR_LABEL" \ -"--draft") - -##### -# Gutenberg PR -##### - -# Get Checklist from Gutenberg PR template -cd gutenberg -GUTENBERG_PR_TEMPLATE_PATH=".github/PULL_REQUEST_TEMPLATE.md" -test -f "$GUTENBERG_PR_TEMPLATE_PATH" || abort "Error: Could not find PR template at $GUTENBERG_PR_TEMPLATE_PATH" -# Get the checklist from the gutenberg PR template by removing everything before the '## Checklist:' line -CHECKLIST_FROM_GUTENBERG_PR_TEMPLATE=$(sed -e/'## Checklist:'/\{ -e:1 -en\;b1 -e\} -ed < "$GUTENBERG_PR_TEMPLATE_PATH") - -# Construct body for Gutenberg release PR -GUTENBERG_PR_BEGINNING="## Description -Release $VERSION_NUMBER of the react-native-editor and Gutenberg-Mobile. - -For more information about this release and testing instructions, please see the related Gutenberg-Mobile PR: $GB_MOBILE_PR_URL" -GUTENBERG_PR_BODY="$GUTENBERG_PR_BEGINNING - -$CHECKLIST_FROM_GUTENBERG_PR_TEMPLATE" - -execute "git" "push" "-u" "origin" "HEAD" - -# Create Draft Gutenberg Release PR in GitHub -GUTENBERG_PR_URL=$(execute "gh" "pr" "create" \ -"--title" "Mobile Release v$VERSION_NUMBER" \ -"--body" "$GUTENBERG_PR_BODY" \ -"--repo" "$GUTENBERG_REPO/gutenberg" \ -"--head" "$GUTENBERG_REPO:$GB_RELEASE_BRANCH" \ -"--base" "$GUTENBERG_TARGET_BRANCH" \ -"--label" "$GUTENBERG_PR_LABEL" \ -"--draft") -cd .. - -echo "PRs Created" -echo "===========" -printf "Gutenberg-Mobile PR %s \n Gutenberg %s \n" "$GB_MOBILE_PR_URL" "$GUTENBERG_PR_URL" | column -t - -confirm_to_proceed "Do you want to proceed with creating main apps (WPiOS and WPAndroid) PRs?" -ohai "Proceeding to create main apps PRs..." - -GB_MOBILE_PR_REF=$(git rev-parse HEAD) - -WP_APPS_PR_TITLE="Integrate gutenberg-mobile release $VERSION_NUMBER" - -WP_APPS_PR_BODY="## Description -This PR incorporates the $VERSION_NUMBER release of gutenberg-mobile. -For more information about this release and testing instructions, please see the related Gutenberg-Mobile PR: $GB_MOBILE_PR_URL - -Release Submission Checklist - -- [ ] I have considered if this change warrants user-facing release notes and have added them to \`RELEASE-NOTES.txt\` if necessary." - -WP_APPS_INTEGRATION_BRANCH="gutenberg/integrate_release_$VERSION_NUMBER" - -##### -# WPiOS PR -##### - -read -r -p "Do you want to target $WPIOS_TARGET_BRANCH branch for WPiOS PR? (y/n) " -n 1 -echo "" -if [[ $REPLY =~ ^[Nn]$ ]]; then - read -r -p "Enter the branch name you want to target. Make sure a branch with this name already exists in WPiOS repository: " WPIOS_TARGET_BRANCH -fi - -TEMP_WP_IOS_DIRECTORY=$(mktemp -d) -ohai "Clone WordPress-iOS into '$TEMP_WP_IOS_DIRECTORY'" -execute "git" "clone" "-b" "$WPIOS_TARGET_BRANCH" "--depth=1" "git@github.com:$MOBILE_REPO/WordPress-iOS.git" "$TEMP_WP_IOS_DIRECTORY" - cd "$TEMP_WP_IOS_DIRECTORY" -ohai "Create after_x.xx.x branch in WordPress-iOS" -execute "git" "switch" "-c" "gutenberg/after_$VERSION_NUMBER" - -execute "git" "push" "-u" "origin" "HEAD" - -ohai "Create release branch in WordPress-iOS" -execute "git" "switch" "-c" "gutenberg/integrate_release_$VERSION_NUMBER" - ohai "Update GitHub organization and gutenberg-mobile ref" ios_config_file="Gutenberg/config.yml" test -f "$ios_config_file" || abort "Error: Could not find $ios_config_file" @@ -361,78 +95,3 @@ execute_until_succeeds "rake" "dependencies" execute "git" "add" "Podfile" "Podfile.lock" "$ios_config_file" execute "git" "commit" "-m" "Release script: Update gutenberg-mobile ref" - -ohai "Push integration branch" -execute "git" "push" "-u" "origin" "HEAD" - -# Create Draft WPiOS Release PR in GitHub -ohai "Create Draft WPiOS Release PR in GitHub" -WP_IOS_PR_URL=$(execute "gh" "pr" "create" \ -"--title" "$WP_APPS_PR_TITLE" \ -"--body" "$WP_APPS_PR_BODY" \ -"--repo" "$MOBILE_REPO/WordPress-iOS" \ -"--head" "$MOBILE_REPO:$WP_APPS_INTEGRATION_BRANCH" \ -"--base" "$WPIOS_TARGET_BRANCH" \ -"--label" "$WPIOS_PR_LABEL" \ -"--draft") - -ohai "WPiOS PR Created: $WP_IOS_PR_URL" -echo "" - -##### -# WPAndroid PR -##### -read -r -p "Do you want to target $WPANDROID_TARGET_BRANCH branch for WPAndroid PR? (y/n) " -n 1 -echo "" -if [[ $REPLY =~ ^[Nn]$ ]]; then - read -r -p "Enter the branch name you want to target. Make sure a branch with this name already exists in WPAndroid repository: " WPANDROID_TARGET_BRANCH -fi - -TEMP_WP_ANDROID_DIRECTORY=$(mktemp -d) -ohai "Clone WordPress-Android into '$TEMP_WP_ANDROID_DIRECTORY'" -execute "git" "clone" "-b" "$WPANDROID_TARGET_BRANCH" "--depth=1" "git@github.com:$MOBILE_REPO/WordPress-Android.git" "$TEMP_WP_ANDROID_DIRECTORY" - -cd "$TEMP_WP_ANDROID_DIRECTORY" - -# This is still needed because of Android Stories. -execute "git" "submodule" "update" "--init" "--recursive" "--depth=1" "--recommend-shallow" - -ohai "Create after_x.xx.x branch in WordPress-Android" -execute "git" "switch" "-c" "gutenberg/after_$VERSION_NUMBER" - -execute "git" "push" "-u" "origin" "HEAD" - -ohai "Create release branch in WordPress-Android" -execute "git" "switch" "-c" "$WP_APPS_INTEGRATION_BRANCH" - -# Get the last part of the path from GB_MOBILE_PR_URL -PULL_ID=${GB_MOBILE_PR_URL##*/} - -ohai "Update build.gradle file with the latest version" -test -f "build.gradle" || abort "Error: Could not find build.gradle" -sed -i '' -E "s/gutenbergMobileVersion = '(.*)'/gutenbergMobileVersion = '${PULL_ID}-$GB_MOBILE_PR_REF'/" build.gradle || abort "Error: Failed updating gutenbergMobileVersion in build.gradle" - -execute "git" "add" "build.gradle" -execute "git" "commit" "-m" "Release script: Update build.gradle gutenbergMobileVersion to ref" - -ohai "Push integration branch" -execute "git" "push" "-u" "origin" "HEAD" - -# Create Draft WPAndroid Release PR in GitHub -ohai "Create Draft WPAndroid Release PR in GitHub" -WP_ANDROID_PR_URL=$(execute "gh" "pr" "create" \ -"--title" "$WP_APPS_PR_TITLE" \ -"--body" "$WP_APPS_PR_BODY" --repo "$MOBILE_REPO/WordPress-Android" \ -"--head" "$MOBILE_REPO:$WP_APPS_INTEGRATION_BRANCH" \ -"--base" "$WPANDROID_TARGET_BRANCH" \ -"--label" "$WPANDROID_PR_LABEL" \ -"--draft") - -ohai "WPAndroid PR Created: $WP_ANDROID_PR_URL" -echo "" - - - -echo "Main apps PRs created" -echo "===========" -printf "WPAndroid %s \n WPiOS %s \n" "$WP_ANDROID_PR_URL" "$WP_IOS_PR_URL" | column -t ``` How to run it: ``` TEMP_WP_IOS_DIRECTORY=../path/to/wordpress-ios ./release_automation.sh ``` Follow the prompts the script gives. It should succeed and generate a commit like this: ``` commit 59a5736ff35820c3b83c4be1e20fe22f8937a3bc Author: Gio LodiUpdate instructions after https://github.com/wordpress-mobile/release-toolkit-gutenberg-mobile/pull/142#issuecomment-1684418261
I tested it by using the following script:
I called it like
sh ./test.sh ../wordpress-iosand verifiedGutenberg/config.ymlchanged withNotice that the branch in the local copy of WordPress-iOS needs to be
mokagio/gutenberg-yaml-settings