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

Enable reporting results directly as a GitHub check #30

Open
andrewiggins opened this issue Oct 4, 2020 · 1 comment
Open

Enable reporting results directly as a GitHub check #30

andrewiggins opened this issue Oct 4, 2020 · 1 comment

Comments

@andrewiggins
Copy link
Owner

Open questions:

  1. Should results always be reported as a check in addition to the comment (if possible)
  2. Should results only be reported as a check if comment failed?
  3. Should results be reported as a check based on an action input?
  4. Some combination of the above?

Right now I'm leaning towards 3.

IIRC, I think using the Checks API inside of an action will result in an additional check being reported in the checks list. In other words, if you run this action in a workflow called "benchmarks" and the check is called "benchmarks check", then in the list of checks at the bottom of the PR will include a "benchmarks" line item (representing that the workflow successfully completed) and a "benchmarks check" line item for the check the workflow manually created.

That duplicate line item probably doesn't impact lit-html as much since it runs all of it benchmarks in one workflow, but for Preact (which runs each benchmark in its own workflow) it would mean we'd have 8 line items related to benchmarks compared to 4. Hence I'm leaning to 3.

Relevant commit: 96645e6

@andrewiggins
Copy link
Owner Author

Another option to consider:

Add an option use-check that takes 3 values: always, never, on-forks with the default being on-forks.

  • always: Always report as GitHub check
  • never: Never report as GitHub check
  • on-forks: If PR is opened is a fork, then report as check

To me, this seems to be the best cause it provides a smart default for people, but gives them the option to opt-out or always opt-in based on preference.

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

No branches or pull requests

1 participant