-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Publish DMG Release workflow to support public and hotfix rele…
…ases (#2239) Task/Issue URL: https://app.asana.com/0/1199230911884351/1206616537326298/f Description: This change updates publish_dmg_release.yml workflow to take an extra parameter called release-type (internal, public or hotfix) and adjust calls to appcastManager and upload_to_s3.sh so that they perform necessary work for public and hotfix release as needed.
- Loading branch information
Showing
11 changed files
with
217 additions
and
231 deletions.
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
.github/actions/asana-add-comment/templates/appcast-failed-hotfix.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| data: | ||
| html_text: | | ||
| <body> | ||
| <h2>[ACTION NEEDED] Publishing ${TAG} hotfix release to Sparkle failed</h2> | ||
| <a data-asana-gid='${ASSIGNEE_ID}'/>, please proceed with generating appcast2.xml and uploading files to S3 from your local machine, <a data-asana-gid='${TASK_ID}' data-asana-dynamic='false'>according to instructions</a>. | ||
| 🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>. | ||
| </body> |
File renamed without changes.
9 changes: 9 additions & 0 deletions
9
.github/actions/asana-add-comment/templates/appcast-failed-public.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| data: | ||
| html_text: | | ||
| <body> | ||
| <h2>[ACTION NEEDED] Publishing ${TAG} release to Sparkle failed</h2> | ||
| <a data-asana-gid='${ASSIGNEE_ID}'/>, please proceed with generating appcast2.xml and uploading files to S3 from your local machine, <a data-asana-gid='${TASK_ID}' data-asana-dynamic='false'>according to instructions</a>. | ||
| 🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>. | ||
| </body> |
8 changes: 8 additions & 0 deletions
8
.github/actions/asana-add-comment/templates/public-release-complete.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| data: | ||
| html_text: | | ||
| <body> | ||
| Build ${TAG} is now available publicly through Sparkle and TestFlight. | ||
| <a href='${DMG_URL}'>📥 DMG download link</a> | ||
| </body> |
11 changes: 11 additions & 0 deletions
11
.github/actions/asana-add-comment/templates/validate-check-for-updates-public.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| data: | ||
| html_text: | | ||
| <body> | ||
| <h2>Build ${TAG} is available publicly through Sparkle 🚀</h2> | ||
| <ul> | ||
| <li>🌟 New appcast file has been generated and uploaded to S3, together with binary delta files.</li> | ||
| <li>👀 <a data-asana-gid='${ASSIGNEE_ID}'/>, please proceed by following instructions in <a data-asana-gid='${TASK_ID}'/> which concludes the release process.</li> | ||
| </ul> | ||
| 🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>. | ||
| </body> |
36 changes: 36 additions & 0 deletions
36
.github/actions/asana-create-action-item/templates/appcast-failed-hotfix.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| data: | ||
| name: Generate appcast2.xml for ${TAG} hotfix release and upload assets to S3 | ||
| assignee: "${ASSIGNEE_ID}" | ||
| html_notes: | | ||
| <body> | ||
| Publishing ${TAG} hotfix release failed in CI. Please follow the steps to generate the appcast file and upload files to S3 from your local machine. | ||
| <ol> | ||
| <li>Create a new file called <code>release-notes.txt</code> on your disk. | ||
| <ul> | ||
| <li>Add each release note as a separate line and don't add bullet points (•) – the script will add them automatically.</li> | ||
| </ul></li> | ||
| <li>Run <code>appcastManager</code>: | ||
| <ul> | ||
| <li><code>./scripts/appcast_manager/appcastManager.swift --release-hotfix-to-public-channel --dmg ~/Downloads/${DMG_NAME} --release-notes release-notes.txt</code></li> | ||
| </ul></li> | ||
| <li>Verify that the new build is in the appcast file with the latest release notes and no internal channel tag. The phased rollout tag should <em>not</em> be present: | ||
| <ul> | ||
| <li><code><sparkle:phasedRolloutInterval>43200</sparkle:phasedRolloutInterval></code></li> | ||
| </ul></li> | ||
| <li>Run <code>upload_to_s3.sh</code> script: | ||
| <ul> | ||
| <li><code>./scripts/upload_to_s3/upload_to_s3.sh --run --overwrite-duckduckgo-dmg ${VERSION}</code></li> | ||
| </ul></li> | ||
| </ol> | ||
| When done, please verify that "Check for Updates" works correctly: | ||
| <ol> | ||
| <li>Launch a debug version of the app with an old version number.</li> | ||
| <li>Make sure you're not identified as an internal user in the app.</li> | ||
| <li>Go to Main Menu → DuckDuckGo → Check for Updates...</li> | ||
| <li>Verify that you're being offered to update to ${TAG}.</li> | ||
| <li>Verify that the update works.</li> | ||
| </ol> | ||
| 🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>. | ||
| </body> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
.github/actions/asana-create-action-item/templates/appcast-failed-public.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| data: | ||
| name: Generate appcast2.xml for ${TAG} public release and upload assets to S3 | ||
| assignee: "${ASSIGNEE_ID}" | ||
| html_notes: | | ||
| <body> | ||
| Publishing ${TAG} release failed in CI. Please follow the steps to generate the appcast file and upload files to S3 from your local machine. | ||
| <ol> | ||
| <li>Create a new file called <code>release-notes.txt</code> on your disk. | ||
| <ul> | ||
| <li>Add each release note as a separate line and don't add bullet points (•) – the script will add them automatically.</li> | ||
| </ul></li> | ||
| <li>Run <code>appcastManager</code>: | ||
| <ul> | ||
| <li><code>./scripts/appcast_manager/appcastManager.swift --release-to-public-channel --version ${VERSION} --release-notes release-notes.txt</code></li> | ||
| </ul></li> | ||
| <li>Verify that the new build is in the appcast file with the latest release notes, the phased rollout tag (below) and no internal channel tag: | ||
| <ul> | ||
| <li><code><sparkle:phasedRolloutInterval>43200</sparkle:phasedRolloutInterval></code></li> | ||
| </ul></li> | ||
| <li>Run <code>upload_to_s3.sh</code> script: | ||
| <ul> | ||
| <li><code>./scripts/upload_to_s3/upload_to_s3.sh --run --overwrite-duckduckgo-dmg ${VERSION}</code></li> | ||
| </ul></li> | ||
| </ol> | ||
| When done, please verify that "Check for Updates" works correctly: | ||
| <ol> | ||
| <li>Launch a debug version of the app with an old version number.</li> | ||
| <li>Make sure you're not identified as an internal user in the app.</li> | ||
| <li>Go to Main Menu → DuckDuckGo → Check for Updates...</li> | ||
| <li>Verify that you're being offered to update to ${TAG}.</li> | ||
| <li>Verify that the update works.</li> | ||
| </ol> | ||
| 🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>. | ||
| </body> |
41 changes: 41 additions & 0 deletions
41
.github/actions/asana-create-action-item/templates/validate-check-for-updates-public.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| data: | ||
| name: Validate that 'Check For Updates' upgrades to ${TAG} | ||
| assignee: "${ASSIGNEE_ID}" | ||
| html_notes: | | ||
| <body> | ||
| <h1>Build ${TAG} has been released publicly via Sparkle 🎉</h1> | ||
| Please verify that "Check for Updates" works correctly: | ||
| <ol> | ||
| <li>Launch a debug version of the app with an old version number.</li> | ||
| <li>Make sure you're not identified as an internal user in the app.</li> | ||
| <li>Go to Main Menu → DuckDuckGo → Check for Updates...</li> | ||
| <li>Verify that you're being offered to update to ${TAG}.</li> | ||
| <li>Verify that the update works.</li> | ||
| </ol> | ||
| <h1>🚨In case "Check for Updates" is broken</h1> | ||
| You can restore previous version of the appcast2.xml: | ||
| <ol> | ||
| <li>Download the ${OLD_APPCAST_NAME} file attached to this task.</li> | ||
| <li>Log in to AWS session: | ||
| <ul> | ||
| <li><code>aws --profile ddg-macos sso login</code></li> | ||
| </ul></li> | ||
| <li>Overwrite appcast2.xml with the old version: | ||
| <ul> | ||
| <li><code>aws --profile ddg-macos s3 cp ${OLD_APPCAST_NAME} s3://${RELEASE_BUCKET_NAME}/${RELEASE_BUCKET_PREFIX}/appcast2.xml --acl public-read</code></li> | ||
| </ul></li> | ||
| </ol> | ||
| <hr> | ||
| <h1>Summary of automated changes</h1> | ||
| <h2>Changes to appcast2.xml</h2> | ||
| See the attached <em>${APPCAST_PATCH_NAME}</em> file. | ||
| <h2>Release notes</h2> | ||
| See the attached <em>${RELEASE_NOTES_FILE}</em> file for release notes extracted automatically from <a data-asana-gid='${RELEASE_TASK_ID}' data-asana-dynamic='false'>the release task</a> description. | ||
| <h2>List of files uploaded to S3</h2> | ||
| <ol> | ||
| ${FILES_UPLOADED} | ||
| </ol> | ||
| 🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>. | ||
| </body> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.