Fix loss of run-summary.md in GHA Job Summary
#652
Merged
Conversation
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
Scala Steward's GitHub Action Job Summary, which details success or failure of each repo in the Scala Steward run, was added with scala-steward-org/scala-steward#3071 in June 2023, followed up by scala-steward-org/scala-steward#3088, which ensured that old `run-summary.md` files couldn't persist in the workspace cache (where they might become misleading), by purging them before the cache was saved. Unfortunately scala-steward-org#631 (released with v2.67.0 in September 2024) unintentionally broke the outputting of the Job Summary, because it moved the `saveWorkspaceCache()` call (which among other things deletes the `run-summary.md` file) to a point _before_ the `run-summary.md` file was read and output to the GitHub Action Job Summary. We can see this in these two successive runs of the Guardian's Scala Steward workflow: * Run 6002 (using [email protected]) successfully output the scala-steward summary: https://github.com/guardian/scala-steward-public-repos/actions/runs/11591772739 https://github.com/guardian/scala-steward-public-repos/actions/runs/11591772739/job/32272232470#step:7:4512 * Run 6003 (using [email protected]) silently omitted to output the summary: https://github.com/guardian/scala-steward-public-repos/actions/runs/11592668893 https://github.com/guardian/scala-steward-public-repos/actions/runs/11592668893/job/32275051343#step:7:35 The fix is just to move the code writing the run-summary earlier, to _before_ the new `finally` block introduced by scala-steward-org#631 which executes `saveWorkspaceCache()`. I've also renamed the method to make its actions a little clearer: * OLD: `workspace.saveWorkspaceCache()` * NEW: `workspace.purgeTempFilesAndSaveCache()`
|
|
A snapshot release has been created as You can test it out with: uses: scala-steward-org/scala-steward-action@snapshots/652It will be automatically recreated on any change to this PR. |
rtyley
added a commit
to guardian/scala-steward-public-repos
that referenced
this pull request
Nov 1, 2024
alejandrohdezma
approved these changes
Nov 4, 2024
Thanks @alejandrohdezma ! I see this has gone out in v2.71.0 - thank you! |
rtyley
added a commit
to guardian/scala-steward-public-repos
that referenced
this pull request
Nov 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Scala Steward's GitHub Action Job Summary, which reports success or failure of individual repos in the Scala Steward run, was added with scala-steward-org/scala-steward#3071 in June 2023, followed up by scala-steward-org/scala-steward#3088, which ensured that old
run-summary.mdfiles couldn't persist in the workspace cache (where they might become misleading), by purging them before the cache was saved.Unfortunately #631 (released with v2.67.0 in September 2024) unintentionally broke the outputting of the Job Summary, because it moved the
saveWorkspaceCache()call (which among other things deletes therun-summary.mdfile) to a point before therun-summary.mdfile was read and output to the GitHub Action Job Summary.We can see this in these two successive runs of the Guardian's Scala Steward workflow:
Run 6002 (using scala-steward-action@v2.65.0) successfully output the scala-steward summary: https://github.com/guardian/scala-steward-public-repos/actions/runs/11591772739 https://github.com/guardian/scala-steward-public-repos/actions/runs/11591772739/job/32272232470#step:7:451
Run 6003 (using scala-steward-action@v2.70.0) silently omitted the summary: https://github.com/guardian/scala-steward-public-repos/actions/runs/11592668893 https://github.com/guardian/scala-steward-public-repos/actions/runs/11592668893/job/32275051343#step:7:35
Changes
The fix is just to move the code processing the run-summary earlier, to before the new
finallyblock introduced by #631 which executessaveWorkspaceCache().I've also renamed the method to make its actions a little clearer:
...becomes...
Tests
Without refactoring, testing that the
core.summary.addRaw()method is successfully called with a summary would probably require some kind of large test againstrun()inmain.ts- there are none of those already, and I was too nervous to attempt one!I have run the
scala-steward-org/scala-steward-action@snapshots/652snapshot of this PR with guardian/scala-steward-public-repos#78, and confirmed that the report is properly restored to the Job Summary: