Allow docs only tests, this time making them work #749
Conversation
Codecov Report
@@ Coverage Diff @@
## main #749 +/- ##
=======================================
Coverage 97.13% 97.13%
=======================================
Files 42 42
Lines 7929 7929
=======================================
Hits 7702 7702
Misses 227 227 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
docs/changes/749.bugfix.rst
Outdated
There was a problem hiding this comment.
This does not affect users, so not sure if you need a change log.
There was a problem hiding this comment.
Yeah, I was in doubt if to put it or not, but it might matter for contributors (I also updated the docs accordingly)
Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
|
Thanks for your review and the fixes @pllim ! |
There was a problem hiding this comment.
I haven't tried this in practice, but I cast an eye over it and it seems to basically make sense. A bit more documentation (a comment in the YAML) would be helpful to explain properly what's supposed to happen.
More generally, I'm not totally convinced that the extra complexity is worth it — I'm not regularly working with Stingray, but my bias is that CI is best left as simple as possible unless it's really causing a problem. That's partly an aesthetic judgement, and I fully defer to you as somebody who is regularly actually using this system!
| smaller commits. Commits involving just the docs might use ``skip ci`` in | ||
| their commit message to avoid running all the tests. | ||
| smaller commits. Commits involving just the docs might use ``[docs only]`` in | ||
| their commit message to avoid running all the tests. *Very* trivial commits |
There was a problem hiding this comment.
By my reading, the above is only checking the subject of the commit message (%s), not the body. Consider pretty=format:'%B' maybe?
There was a problem hiding this comment.
(Or change this to something like “...in the first line of their commit message...”
There was a problem hiding this comment.
By my reading, above we are checking for doc or skip-tests, but here it says we looking for docs only orskip ci. I'm not actually sure if that's because I don't fully understand what's happening, or if the documentation and the implementation don't match.
There was a problem hiding this comment.
Yeah, I just used a more permissive regex than documented. Skip ci is handled by Github itself and does not need to be treated explicitly
…he regex slightly [docs only]
|
@jdswinbank thanks! |
No description provided.