Skip to content
This repository was archived by the owner on Feb 24, 2025. It is now read-only.

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

Merged
ayoy merged 4 commits into from
Mar 5, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
047ff73
Validate that release notes are present before publishing a new release
ayoy Mar 5, 2024
467d060
Fix internal-release-tag-failed template
ayoy Mar 5, 2024
1fff299
Fix reading release notes from file
ayoy Mar 5, 2024
63eec48
Move check out the code
ayoy Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/actions/asana-create-action-item/templates/internal-release-tag-failed.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ data:
</ul></li>
</ul>

Complete this task when ready and proceed with testing the build.
Complete this task when ready and proceed with testing the build. If you're bumping an internal release, you should get another task asking you to publish the release in Sparkle.
Look for other tasks in <a data-asana-gid='${AUTOMATION_TASK_ID}'/> task and handle them as needed.
Comment on lines +41 to +42
Copy link
Collaborator Author

@ayoy ayoy Mar 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an unrelated change, but I forgot to save the file before submitting my previous pull request #2306



🔗 Workflow URL: <a href='${WORKFLOW_URL}'>${WORKFLOW_URL}</a>.
Expand Down
26 changes: 26 additions & 0 deletions .github/workflows/bump_internal_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,32 @@ jobs:
*) echo "👎 Not a release branch"; exit 1 ;;
esac

- name: Check out the code
uses: actions/checkout@v4
with:
ref: ${{ github.ref_name }}

- name: Extract Asana Task ID
id: task-id
uses: ./.github/actions/asana-extract-task-id
with:
task-url: ${{ github.event.inputs.asana-task-url }}

- name: Validate release notes
env:
TASK_ID: ${{ steps.task-id.outputs.task-id }}
ASANA_ACCESS_TOKEN: ${{ secrets.ASANA_ACCESS_TOKEN }}
run: |
curl -fLSs "https://app.asana.com/api/1.0/tasks/${TASK_ID}?opt_fields=notes" \
-H "Authorization: Bearer ${ASANA_ACCESS_TOKEN}" \
| jq -r .data.notes \
| ./scripts/extract_release_notes.sh > release_notes.txt
release_notes="$(<release_notes.txt)"
if [[ ${#release_notes} == 0 || "$release_notes" == "<-- Add release notes here -->" ]]; then
echo "::error::Release notes are empty. Please add release notes to the Asana task and restart the workflow."
exit 1
fi

run_tests:

name: Run Tests
Expand Down
41 changes: 23 additions & 18 deletions .github/workflows/publish_dmg_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:

name: Tag public release

# Run if release-type is provided (not empty) an is not internal
# Run if release-type is provided (not empty) and is not internal
if: contains(github.event.inputs.release-type, '') == false && github.event.inputs.release-type != 'internal'

uses: ./.github/workflows/tag_release.yml
Expand Down Expand Up @@ -111,6 +111,28 @@ jobs:
- name: Select Xcode
run: sudo xcode-select -s /Applications/Xcode_$(<.xcode-version).app/Contents/Developer

- name: Extract Asana Task ID
id: task-id
uses: ./.github/actions/asana-extract-task-id
with:
task-url: ${{ github.event.inputs.asana-task-url }}

- name: Fetch and validate release notes
env:
TASK_ID: ${{ steps.task-id.outputs.task-id }}
ASANA_ACCESS_TOKEN: ${{ secrets.ASANA_ACCESS_TOKEN }}
run: |
curl -fLSs "https://app.asana.com/api/1.0/tasks/${TASK_ID}?opt_fields=notes" \
-H "Authorization: Bearer ${ASANA_ACCESS_TOKEN}" \
| jq -r .data.notes \
| ./scripts/extract_release_notes.sh > release_notes.txt
release_notes="$(<release_notes.txt)"
if [[ ${#release_notes} == 0 || "$release_notes" == "<-- Add release notes here -->" ]]; then
echo "::error::Release notes are empty. Please add release notes to the Asana task and restart the workflow."
exit 1
Comment on lines +129 to +132
Copy link
Collaborator Author

@ayoy ayoy Mar 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 129-132 is the new code. The rest was moved so that the check happens before fetching the DMG.

fi
echo "RELEASE_NOTES_FILE=release_notes.txt" >> $GITHUB_ENV

- name: Set up Sparkle tools
env:
SPARKLE_URL: https://github.com/sparkle-project/Sparkle/releases/download/${{ vars.SPARKLE_VERSION }}/Sparkle-${{ vars.SPARKLE_VERSION }}.tar.xz
Expand All @@ -131,23 +153,6 @@ jobs:
echo "dmg-name=$DMG_NAME" >> $GITHUB_OUTPUT
echo "dmg-path=$DMG_NAME" >> $GITHUB_OUTPUT

- name: Extract Asana Task ID
id: task-id
uses: ./.github/actions/asana-extract-task-id
with:
task-url: ${{ github.event.inputs.asana-task-url }}

- name: Fetch release notes
env:
TASK_ID: ${{ steps.task-id.outputs.task-id }}
ASANA_ACCESS_TOKEN: ${{ secrets.ASANA_ACCESS_TOKEN }}
run: |
curl -fLSs "https://app.asana.com/api/1.0/tasks/${TASK_ID}?opt_fields=notes" \
-H "Authorization: Bearer ${ASANA_ACCESS_TOKEN}" \
| jq -r .data.notes \
| ./scripts/extract_release_notes.sh > release_notes.txt
echo "RELEASE_NOTES_FILE=release_notes.txt" >> $GITHUB_ENV

- name: Generate appcast
id: appcast
env:
Expand Down