coverallsapp / coverallsapp/github-action
[Doc Bug] What causes the check to fail?
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 520
- Forks
- 78
- PR merge metrics
- No merged PRs in 30d
Description
I apologize if I missed this, and I'm sure it will become immediately obvious once I begin using it, but what exactly makes the "Coveralls Check" fail?
- Does it fail anytime new coverage is less than existing coverage?
- Does it have any other criteria?
- Can the criteria be modified?
It may be worth mentioning, if (1) is true, that is exactly what I'm looking for.
I am trying to make a business case to migrate us onto Coveralls, and I don't know what causes the GitHub check to fail by simply reading your documentation.
A simple bulleted of "the rules" is all I need, and I think it would also make a great addition to your README.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README section describing the Coveralls Check and verify how its pass/fail behavior is currently documented. Add a short bulleted list covering whether lower coverage fails, any other criteria, and whether those criteria can be changed; done means a reader can answer all three questions from the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100