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

CI: Check that blog builds without warnings #29

Merged
merged 4 commits into from
Jul 31, 2024
Merged

Conversation

alexdewar
Copy link
Contributor

Add a workflow to run MkDocs in strict mode to check for build warnings and errors.

Closes #25.

Add a workflow to run MkDocs in strict mode to check for build warnings and errors.

Closes #25.
Copy link
Contributor

@SaranjeetKaur SaranjeetKaur left a comment

Choose a reason for hiding this comment

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

nice one!

Copy link
Contributor

@cc-a cc-a left a comment

Choose a reason for hiding this comment

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

Nice. A few suggestions.

Comment on lines 4 to 5
push:
branches: [main]
Copy link
Contributor

Choose a reason for hiding this comment

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

Won't this be inherently covered by the publish workflow?

Copy link
Contributor Author

@alexdewar alexdewar Jul 31, 2024

Choose a reason for hiding this comment

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

Kiiiind of. We're not building the docs in strict mode for the publish workflow though, which means warnings could creep in.

How about we just use strict mode for the publish workflow?

Copy link
Contributor

Choose a reason for hiding this comment

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

That makes sense. At the moment having this workflow run on push wouldn't actually stop the publication from happening anyway so best to mae the strictness consistent.

.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
@alexdewar alexdewar requested a review from cc-a July 31, 2024 09:04
Copy link
Contributor

@cc-a cc-a left a comment

Choose a reason for hiding this comment

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

Great. Good stuff.

@alexdewar alexdewar merged commit df810ca into main Jul 31, 2024
3 checks passed
@alexdewar alexdewar deleted the ci-mkdocs-check branch July 31, 2024 09:13
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.

Check for mkdoc warnings
3 participants