Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow a config option to alter the fail outcome when blocking an issue #31

Open
instantiator opened this issue Feb 4, 2025 · 2 comments · May be fixed by #32
Open

Allow a config option to alter the fail outcome when blocking an issue #31

instantiator opened this issue Feb 4, 2025 · 2 comments · May be fixed by #32

Comments

@instantiator
Copy link

instantiator commented Feb 4, 2025

Context

At the moment, when successfully blocking an issue, the action reports a failed state. This seems intentional, and I can understand why you've done it. However, this is the same response we'd expect to see when something went wrong and the action couldn't run to completion (eg. incomplete permissions, couldn't find an issue, etc.)

Desired behaviour

Allow the user to specify an input to determine whether blocking an issue should be considered a successful action, or a failure. (Default behaviour can remain the same.)

eg. something like

    steps:
      - uses: Levi-Lesches/blocking-issues@v2
        with:
          use-label: "blocked"
          fail-on-block: "false"

This means the action can still be used in longer workflows - and will continue to prevent them from completing if the issue is blocked, but users can optionally allow them to run quietly in the background without disruptively showing as errors, by setting fail-on-block: "false"

Workarounds

NB. Setting continue-on-error: true on the step is an OK workaround provided you trust that the action is working. It permits the action to complete without failing the workflow, but cannot distinguish between unintended errors and successfully blocking an issue.

@instantiator instantiator linked a pull request Feb 4, 2025 that will close this issue
@instantiator
Copy link
Author

Added an unsolicited PR - see how you like it!

@Levi-Lesches
Copy link
Owner

Really hoping people aren't running into random failures! But this can be useful. I'll try to merge that soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants