Display GitHub Action Job Summary #502
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
This is the complementary PR for scala-steward-org/scala-steward#3071 - while that PR _creates_ the summary report, this is the PR that links up to GitHub's `core.summary` workflow command, to _display_ the report in GitHub's Job summary. https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#:~:text=core.summary https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/#:~:text=core.summary In this change, if the `run-summary.md` file generated by the Scala Steward JVM process is found, it's written to the GitHub summary.
|
|
A snapshot release has been created as You can test it out with: uses: scala-steward-org/scala-steward-action@snapshots/502It will be automatically recreated on any change to this PR. |
alejandrohdezma
approved these changes
Jun 15, 2023
Thanks @alejandrohdezma ! Are you ok to merge scala-steward-org/scala-steward#3071 too, in order to be able to try this out? |
rtyley
added a commit
to rtyley/scala-steward-action
that referenced
this pull request
Jun 16, 2023
This was something we missed from scala-steward-org#502 - because the `run-summary.md` file is saved by scala-steward-org/scala-steward#3071 to the Scala Steward workspace, and almost the entire workspace is persisted to cache by Scala Steward's GitHub Action, the report would be persisted until the _next_ run of the GitHub Action, and concievably, if the next run went wrong somehow, the incorrect _old_ summary could get reported against that subsequent run, which would be bad. The fix here is to delete the summary at the `saveWorkspaceCache()` step, which occurs after the summary has been transferred to the `GITHUB_STEP_SUMMARY` file by calling `core.summary()`.
rtyley
added a commit
to guardian/scala-steward-public-repos
that referenced
this pull request
Jun 16, 2023
This includes scala-steward-org/scala-steward-action#502, for a more friendly summary of which repos failed or succeeded as Scala Steward was processing them.
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.
This is the complementary PR for scala-steward-org/scala-steward#3071.
While that PR creates the summary report, this is the PR that links up to GitHub's
core.summaryworkflow command (as suggested by @alejandrohdezma in scala-steward-org/scala-steward#3071 (review)), to display the report in GitHub's Job summary.In this change, if the
run-summary.mdfile generated by the Scala Steward JVM process is found, it's written to the GitHub summary - if it's not found, that's not regarded as an error, tolerating older Scala Steward versions if they're being used.