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

Check reference docs are up to date in CI #64

Merged
merged 2 commits into from
Jan 5, 2024
Merged

Conversation

huonw
Copy link
Contributor

@huonw huonw commented Jan 5, 2024

This does a basic version of validating that the checked-in reference docs are valid, i.e. regenerating them gives the same result. It does this by just running the generation and checking that there's no changes.

This ensures that we don't, for instance, make a change to the templates and then forget to regenerate everything.

@huonw huonw force-pushed the huonw/reference-up-to-date branch from 3456057 to 4fbf5b5 Compare January 5, 2024 00:59
@huonw
Copy link
Contributor Author

huonw commented Jan 5, 2024

This won't work until #65 lands.

@huonw huonw force-pushed the huonw/reference-up-to-date branch from 4fbf5b5 to b5ad8a4 Compare January 5, 2024 01:29
Copy link
Member

@thejcannon thejcannon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it

@huonw huonw marked this pull request as ready for review January 5, 2024 03:03
@huonw huonw merged commit f2c7307 into main Jan 5, 2024
1 check passed
@huonw huonw deleted the huonw/reference-up-to-date branch January 5, 2024 03:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants