Only return a failure exit code when all repos have failed #3369
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
When even one repository fails in a scala steward run the workspace is not persisted by GitHub Actions because GH Actions won't persist the workspace of a failing job. Persisting workspace is crucial for respecting `pullRequests.frequency` configuration because the workspace is how scala steward records that it has opened a pull request. This means that one failing repository can cause a lot of user annoyance because their configuration is no longer respected and they get too many PRs opened. This change aims to fix that by only returning a failure code if *all* repos have failed. So long as at least one repository succeeded the exit code will be success and the workspace will persist. If administrators need to know what repos are failing they can use the jobs summary introduced by: scala-steward-org#3071 See more here: guardian/scala-steward-public-repos#60 Co-authored-by: Roberto Tyley <[email protected]>
|
@mzuehlke how does this look to you? To us at the Guardian this does seems like the best fix to the problem? One possible alternative would be to modify the behaviour of |
|
Hey @ioannakok, thanks for this! I think this could make sense for a lot of use cases, but not for others. Maybe we can expand on it and put it behind a flag that's been sent in the params. That way we can propagate that flag from the action and people can decide whether to fail if everything is failing or not. What do you think? |
rtyley
added a commit
to guardian/scala-steward
that referenced
this pull request
Jun 11, 2024
The new `--exit-code-success-if-any-repo-succeeds` CLI flag alters the default behaviour of the exit-code of the Scala Steward process - the exit code will be success (`0`) if the processing of _any_ repo has succeeded, rather than requiring that _all_ repos are successfully processed. This is useful when running Scala Steward with the Scala Steward GitHub Action - it means that the filesystem _will_ be persisted, along with the record of what PRs have been raised, which is what you _want_ to happen, even if some repos have failed. As Alejandro mentioned: scala-steward-org#3369 (comment) ...this behaviour may not always be desired, so we're disabling it by default.
rtyley
added a commit
to guardian/scala-steward
that referenced
this pull request
Jun 11, 2024
The new `--exit-code-success-if-any-repo-succeeds` CLI flag alters the default behaviour of the exit-code of the Scala Steward process - the exit code will be success (`0`) if the processing of _any_ repo has succeeded, rather than requiring that _all_ repos are successfully processed. This is useful when running Scala Steward with the Scala Steward GitHub Action - it means that the filesystem _will_ be persisted, along with the record of what PRs have been raised, which is what you _want_ to happen, even if some repos have failed. As Alejandro mentioned: scala-steward-org#3369 (comment) ...this behaviour may not always be desired, so we're disabling it by default.
rtyley
force-pushed
the
only-use-failure-exit-code-when-all-repos-have-failed
branch
from
49a28b2 to
e8f6b9b
Compare
rtyley
added a commit
to guardian/scala-steward
that referenced
this pull request
Jun 11, 2024
The new `--exit-code-success-if-any-repo-succeeds` CLI flag alters the default behaviour of the exit-code of the Scala Steward process - the exit code will be success (`0`) if the processing of _any_ repo has succeeded, rather than requiring that _all_ repos are successfully processed. This is useful when running Scala Steward with the Scala Steward GitHub Action - it means that the filesystem _will_ be persisted, along with the record of what PRs have been raised, which is what you _want_ to happen, even if some repos have failed. As Alejandro mentioned: scala-steward-org#3369 (comment) ...this behaviour may not always be desired, so we're disabling it by default.
rtyley
force-pushed
the
only-use-failure-exit-code-when-all-repos-have-failed
branch
from
e8f6b9b to
8286c0f
Compare
The new `--exit-code-success-if-any-repo-succeeds` CLI flag alters the default behaviour of the exit-code of the Scala Steward process - the exit code will be success (`0`) if the processing of _any_ repo has succeeded, rather than requiring that _all_ repos are successfully processed. This is useful when running Scala Steward with the Scala Steward GitHub Action - it means that the filesystem _will_ be persisted, along with the record of what PRs have been raised, which is what you _want_ to happen, even if some repos have failed. As Alejandro mentioned: scala-steward-org#3369 (comment) ...this behaviour may not always be desired, so we're disabling it by default.
rtyley
force-pushed
the
only-use-failure-exit-code-when-all-repos-have-failed
branch
from
8286c0f to
0607cfc
Compare
Thanks @alejandrohdezma - I've added a flag with 0607cfc, does that look ok? |
|
Great work! Thanks! ❤️ |
mzuehlke
reviewed
Jun 12, 2024
Merged
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.
When even one repository fails in a scala steward run the workspace is not persisted by GitHub Actions because GH Actions won't persist the workspace of a failing job. Persisting workspace is crucial for respecting
pullRequests.frequencyconfiguration because the workspace is how scala steward records that it has opened a pull request. This means that one failing repository can cause a lot of user annoyance because their configuration is no longer respected and they get too many PRs opened. This change aims to fix that by only returning a failure code if all repos have failed. So long as at least one repository succeeded the exit code will be success and the workspace will persist. If administrators need to know what repos are failing they can use the jobs summary introduced by: #3071See more here: guardian/scala-steward-public-repos#60
cc @alejandrohdezma