feat(docs): skip markdown files that lack attributes #729
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
This updates our
docs
/changelogs
/custompages
commands to skip over any Markdown files that lack YAML frontmatter attributes.Of all of the requests we get for docs syncing improvements (more are in the pipeline, we promise!), this one is by far the lowest hanging fruit and doesn't require a breaking change1, in my opinion.
🧬 QA & Testing
I updated our test bed to reflect this, but you can test this out yourself by checking out this branch and running the following command:
Footnotes
The reason I don't think it's a breaking change is because we require a
title
attribute on every page type, so if a Markdown file lacked frontmatter attributes,rdme
would almost certainly error out on it. With this change,rdme
will skip over it instead and proceed with everything else as normal. ↩