Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): skip markdown files that lack attributes #729

Merged
merged 8 commits into from
Jan 9, 2023

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Jan 4, 2023

🚥 Fixes #539

🧰 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:

npm run debug -- changelogs README.md

Footnotes

  1. 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.

@kanadgupta kanadgupta added enhancement New feature or request command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Jan 4, 2023
@kanadgupta kanadgupta changed the title feat(docs): skip files with no frontmatter feat(docs): skip markdown files that lack attributes Jan 4, 2023
@kanadgupta kanadgupta marked this pull request as ready for review January 4, 2023 23:55
documentation/rdme.md Show resolved Hide resolved
@kanadgupta kanadgupta merged commit cb4129d into main Jan 9, 2023
@kanadgupta kanadgupta deleted the skip-docs-with-no-attributes branch January 9, 2023 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sync files which only has title and category attributes in the markdown files
2 participants