Add automation for linting the spec #1543
Conversation
jdesrosiers
force-pushed
the
spec-lint-automation
branch
3 times, most recently
from
771d86f to
9d32eb6
Compare
| - Issue discussing feature - https://github.com/json-schema-org/json-schema-spec/issues/1082 | ||
| - PR to add to the spec - https://github.com/json-schema-org/json-schema-spec/pull/1143 | ||
| - ADR to extract from the spec and use feature life cycle - https://github.com/json-schema-org/json-schema-spec/pull/1505 | ||
| - Issue discussing feature - <https://github.com/json-schema-org/json-schema-spec/issues/1082> |
There was a problem hiding this comment.
The angle brackets are markdown syntax for URLs. We aren't used to using them because Github-flavored markdown detects URLs automatically and turns them into links. The markdown style guide the linting plugin is based on prefers the explicit syntax. I think the rationale makes sense. By forcing you to use angle brackets or backticks, it helps catch errors where a URL is converted to a link when it wasn't intended to be.
|
Our Additional context: I've created a |
Yes, that should be pretty easy to do. |
jdesrosiers
force-pushed
the
spec-lint-automation
branch
from
9d32eb6 to
ff297d5
Compare
|
(The force push as just a rebase. Nothing changed.) |
|
I originally removed the ietf build from the ci, but then remembered that we still have a couple specs (RJP) that still use it, so I put it back. |
There was a problem hiding this comment.
Thanks for these. I think we should merge this ASAP. We can discuss on today's OCWM.
When I setup the build script for the markdown-based spec, I included a markdown linter and link checker. Unfortunately, that isn't being used during development and a lot of errors have gotten in. This PR adds automation to make sure schema authors are aware when they are introducing errors.
This also includes linting automation for the build scripts themselves.