Fix CI vale check reporting and resolve vale errors#1278
Fix CI vale check reporting and resolve vale errors#1278gilangjavier wants to merge 2 commits intocollective:mainfrom
Conversation
There was a problem hiding this comment.
Please revert all changes to this file. They're not correct, and they're irrelevant to the issue.
| Args | ||
| backported | ||
| (?i)datetime | ||
| Repology |
There was a problem hiding this comment.
We first need to show that changes to the CI resolve the false positive. Please delete this change for now so it can be tested, and once the CI check does in fact fail, then it may be added and sorted alphabetically so it can pass. Does that make sense?
| echo "For guidance of how to correct the errors, see:"; \ | ||
| echo "https://icalendar.readthedocs.io/en/latest/contribute/documentation/build-check.html#spelling-grammar-and-style"; \ | ||
| fi | ||
| @uv run vale --no-wrap $(VALEOPTS) $(VALEFILES) |
There was a problem hiding this comment.
This change doesn't resolve the false positive.
This change purges a helpful message. Please don't remove it.
If the logic captures, but doesn't return the correct exit code, then the commands should be modified to return it.
|
I've added the missing changelog entry in CHANGES.rst. The changelog verifier is now green. |
|
@gilangjavier thank you. However, we still need to see a failure in CI to verify that the changes actually do what we want. See #1278 (comment). |
This PR fixes the CI to correctly report a failure when
make valereturns an error code by removing the shell conditional in the Makefile that was swallowing the exit status. It also resolves existing Vale errors:docs/reference/component-api.rst.docs/contribute/maintenance.rst.docs/how-to/install.rst.docs/contribute/maintenance.rstto use trailing commas for consistency.📚 Documentation preview 📚: https://icalendar--1278.org.readthedocs.build/