Stale check runs #24761
-
I’m planning to create an app that uses the Check Runs API. The checks performed on the code will not be automated, and thus could take a very long time to complete. I noticed that if a check is in progress for more than 14 days GitHub will automatically mark the run as stale (https://developer.github.com/v3/checks/runs/). I have a couple of questions about stale check runs:
|
Beta Was this translation helpful? Give feedback.
Replies: 8 comments 1 reply
-
👋 hello there @danthedaniel, and welcome to the GitHub Support Community! 🎉
Once a check run transitions from the
Yes. If a check is required as a part of a protected branch’s settings, the check must pass as noted in |
Beta Was this translation helpful? Give feedback.
-
francisfuzz:
But what about when a check run transitions from |
Beta Was this translation helpful? Give feedback.
-
@danthedaniel - Great follow-up question! Every check run has a A Here’s the order in which a
If a check run’s Here’s why: it’s only when a check run’s The value of
Thus, when a check run’s If you have a specific use case for which you would find it helpful to update a check run’s |
Beta Was this translation helpful? Give feedback.
-
Thanks for explaining! |
Beta Was this translation helpful? Give feedback.
-
Actually I have another follow up question. If a run is marked stale can I create a new check run (from the same app) on the same commit as the original check run? Basically what I want is some way to be able to require a check run from my GitHub app even though it could take > 2 weeks to perform. The tool I’m planning to build would block merging a PR until a certain label is applied to all associated issues (if there’s another way to do this please let me know). |
Beta Was this translation helpful? Give feedback.
-
danthedaniel:
Because a check suite can have more than one check run, you should be able to create as many check runs from the same application as you’d like on the same commit. I’d be curious to see if that isn’t the case!
danthedaniel:
Ahh, thanks for sharing that context! One of my colleagues developed a GitHub App called zeke/semantic-pull-requests🤖 Let the robots take care of the semantic versioning - zeke/semantic-pull-requests Its sole purpose is to ensure that pull requests follow the I thought it also might be worth sharing––on a cursory search of Probot’s List of Apps, I noticed that there’s a pr_label_enforcer app that enforces certain labels on a PR before merging by using status checks (source @ https://github.com/fossapps/pr_label_enforcer). I can’t say that I’ve used that particular application nor am I able to provide support for either (since I’m neither a maintainer nor owner), but have used I hope this helps as some helpful resources to check out as you go about with your project! 🙌 |
Beta Was this translation helpful? Give feedback.
-
Thank you so much! I should have searched around more because PR Label Enforcer looks like just what I need. |
Beta Was this translation helpful? Give feedback.
-
Yes, you can modify a check run which is
To update a check run please see our docs on how to update a check run. If you have any feedback about the docs, or this API please share it with our product team on our official product feedback form. |
Beta Was this translation helpful? Give feedback.
Yes, you can modify a check run which is
stale
to any other completed state.Stale conclusions can be updated with the following conclusions:
stale
➡️success
stale
➡️failure
stale
➡️neutral
stale
➡️cancelled
stale
➡️skipped
stale
➡️timed_out
stale
➡️action_required
To update a check run please see our docs on how to update a check run.
If you have any feedback about the docs, or this API please share it with our product team on our official product feedback form.