Publish subsequent internal releases right after building #2306

ayoy · 2024-03-04T13:26:56Z

Task/Issue URL: https://app.asana.com/0/0/1206676349038948/f
CC: @loremattei

Description:
This change combines Bump Internal Release and Publish DMG Release workflows in that the former
calls the latter. As a result, bumping internal release is a single workflow run.

Steps to test this PR:
Check out the following places:

Code Freeze workflow run for a test release, that worked well as it should, because it shouldn't get affected by the changes.
Bump Internal Release workflow run for a test release, that builds the app, tags and merges the branch, and publishes the app to Sparkle (this time it failed because I messed up the appcast file server-side).
Fully successful Bump Internal Release workflow run.
Bump Internal Release workflow run that failed to merge the release branch because of a conflict (introduced deliberately). It created Merge release/0.74.0 to dominik/test-base-branch and proceeded with the release (the tag is created, only merging failed).
When Bump Internal Release fails to create a tag and/or GitHub Release, it posts a similar Merge task, but also another one: Run Publish DMG Release GitHub Actions workflow. Merge task instructs the release DRI to look for other subtasks in the Automation task at the end of the description.
Updated Asana automation comment that is posted after tagging the release, saying that the Sparkle release will be done automatically.

Internal references:

Pull Request Review Checklist
Software Engineering Expectations
Technical Design Template
Pull Request Documentation

ayoy · 2024-03-04T13:31:50Z

.github/actions/asana-add-comment/templates/internal-release-ready.yml

-        <li>📥 DMG is available from <a href='${DMG_URL}'>${DMG_URL}</a>.</li>
+        <li>📥 DMG is available from <a href='${DMG_URL}'>${DMG_URL}</a>.
+          <ul>
+            <li>If this is a subsequent internal release (started by calling <em>Bump Internal Release</em> workflow), the DMG will be automatically published to Sparkle in a few minutes. Sit tight.</li>


This is lame - it should be a separate template, but I didn't have time for it now.

ayoy · 2024-03-04T13:33:05Z

.github/actions/asana-create-action-item/templates/run-publish-dmg-release.yml

+            <li><b>Branch</b> <code>${BRANCH}</code></li>
+            <li><b>Asana release task URL</b> <code>${ASANA_TASK_URL}</code></li>
+            <li><b>Tag to publish</b> <code>${TAG}</code></li>
+            <li><b>Release Type</b> <code>internal</code></li>


Parametrized instructions on how to set up a workflow run 👍

ayoy · 2024-03-04T13:33:42Z

.github/actions/asana-log-message/templates/debug-symbols-uploaded.yml

All these deleted files were not in use (they were copied over to another directory some time ago and not deleted from here).

ayoy · 2024-03-04T13:34:19Z

.github/workflows/bump_internal_release.yml

+  publish_release:
+    name: Publish DMG Release
+    needs: [ tag_and_merge ]
+    uses: ./.github/workflows/publish_dmg_release.yml
+    with:
+      asana-task-url: ${{ github.event.inputs.asana-task-url }}
+    secrets:
+      ASANA_ACCESS_TOKEN: ${{ secrets.ASANA_ACCESS_TOKEN }}
+      AWS_ACCESS_KEY_ID_RELEASE_S3: ${{ secrets.AWS_ACCESS_KEY_ID_RELEASE_S3 }}
+      AWS_SECRET_ACCESS_KEY_RELEASE_S3: ${{ secrets.AWS_SECRET_ACCESS_KEY_RELEASE_S3 }}
+      GHA_ELEVATED_PERMISSIONS_TOKEN: ${{ secrets.GHA_ELEVATED_PERMISSIONS_TOKEN }}
+      SPARKLE_PRIVATE_KEY: ${{ secrets.SPARKLE_PRIVATE_KEY }}


This is the main change here :) every subsequent internal release is automatically published to Sparkle internal channel.

ayoy · 2024-03-04T13:37:59Z

.github/workflows/tag_release.yml

@@ -163,6 +179,17 @@ jobs:
        release-task-url: ${{ env.asana-task-url }}
        template-name: ${{ steps.asana-failure-templates.outputs.task-template }}

+    - name: Create Publish DMG Release task on failure
+      id: create-publish-dmg-task-on-failure
+      if: failure() && env.internal-release-bump == 'true'


We only want this (break the workflow and ask release DRI to publish manually) on a proper failure (failure()). This workflow does not treat merge conflict as failure so it moves on, and since merge conflict is not a blocker for releasing the build (that's already made and tagged in git after all), it gets published automatically on internal release bumps, and the release DRI needs to handle merging separately.

ayoy · 2024-03-04T13:38:50Z

.github/workflows/publish_dmg_release.yml

@@ -43,6 +61,10 @@ jobs:

    name: Publish a release to Sparkle

+    env:
+      RELEASE_TYPE: ${{ github.event.inputs.release-type || 'internal' }}


RELEASE_TYPE is used in a few places in this workflow so I extracted it to the job-level env.

jaceklyp

LGTM :)

# By Alexey Martemyanov (10) and others # Via GitHub * main: (39 commits) Add Peoplewhiz data broker (#2310) Integrate confirm entitlements endpoint for macOS App Store purchase (#2325) Make dbSaveBloomFilterError pixel daily and continuous (#2299) Subscription UI updates (#2303) Add email pattern on opt-out pixel (#2307) Use compile-time checked generated asset names (#2177) fix bundle name in breakByRaisingSigInt (#2319) BSK update for iOS autofill support to delete all passwords (#2254) Bump BrowserServicesKit (#2309) Bump version to 1.78.0 (132) Fix crash on popup window display; adjust naming (#2315) Bump version to 1.78.0 (131) Set marketing version to 1.78.0 Update embedded files Fix parsing commit log (#2311) DBP: Set correct duration of submit-success pixel (#2308) Publish subsequent internal releases right after building (#2306) DBP disable pixel changes (#2293) Remove duplicated broker items (#2294) fix tab title not updated (#2302) ... # Conflicts: # DuckDuckGo.xcodeproj/project.pbxproj # DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

ayoy added 16 commits March 2, 2024 09:25

Publish subsequent internal release immediately after building

6cf9b89

Fix github.event_name checks

1ff9fda

Further fix github.event_name checks

6995a7d

Replace 'workflow_call' usage

284dd63

Fix whitespace

1b8dbfa

Always store the artifact

e7cac3d

Fix release-type checks

c0de433

Fix passing AWS credentials to publish_dmg_release

1ffa2f3

Fix tag variable assignment in publish_dmg_release

c6e8754

Merge branch 'main' into dominik/bump-internal-ng

145613d

Clean up message templates and improve internal-release-ready

b47e251

Fix a template

a603ca6

Add action item about making a DMG release

dfa128b

Simplify the code

d8bb58f

Only post publish DMG release task when tagging fails

bfdd0df

Update merge-failed description

25f4020

ayoy requested a review from jaceklyp March 4, 2024 13:26

ayoy assigned jaceklyp Mar 4, 2024

ayoy commented Mar 4, 2024

View reviewed changes

ayoy added the necessary for release label Mar 4, 2024

Merge branch 'main' into dominik/bump-internal-ng

41f1455

jaceklyp approved these changes Mar 4, 2024

View reviewed changes

ayoy added 2 commits March 4, 2024 16:39

Merge branch 'main' into dominik/bump-internal-ng

faad4c4

Merge branch 'main' into dominik/bump-internal-ng

d694407

ayoy merged commit 676528e into main Mar 4, 2024
17 checks passed

ayoy deleted the dominik/bump-internal-ng branch March 4, 2024 16:26

ayoy mentioned this pull request Mar 5, 2024

Validate that release notes are present before publishing a new release #2321

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Publish subsequent internal releases right after building #2306

Publish subsequent internal releases right after building #2306

ayoy commented Mar 4, 2024 •

edited

Loading

ayoy Mar 4, 2024

ayoy Mar 4, 2024

ayoy Mar 4, 2024

ayoy Mar 4, 2024 •

edited

Loading

ayoy Mar 4, 2024 •

edited

Loading

ayoy Mar 4, 2024

jaceklyp left a comment

Publish subsequent internal releases right after building #2306

Publish subsequent internal releases right after building #2306

Conversation

ayoy commented Mar 4, 2024 • edited Loading

Internal references:

ayoy Mar 4, 2024

Choose a reason for hiding this comment

ayoy Mar 4, 2024

Choose a reason for hiding this comment

ayoy Mar 4, 2024

Choose a reason for hiding this comment

ayoy Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

ayoy Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

ayoy Mar 4, 2024

Choose a reason for hiding this comment

jaceklyp left a comment

Choose a reason for hiding this comment

ayoy commented Mar 4, 2024 •

edited

Loading

ayoy Mar 4, 2024 •

edited

Loading

ayoy Mar 4, 2024 •

edited

Loading