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.

Sign up for GitHub

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

CI: Check that blog builds without warnings #29

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2721f7
CI: Check that blog builds without warnings
alexdewar Jul 29, 2024
72002cb
We're not doing releases...
alexdewar Jul 31, 2024
078977f
Use long form of --strict flag
alexdewar Jul 31, 2024
115c15d
Use mkdocs' --strict flag for publish workflow
alexdewar Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: CI checks

on:
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 •
edited
Loading

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.

pull_request:
release:
alexdewar marked this conversation as resolved.
Show resolved Hide resolved
workflow_dispatch:

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Poetry
uses: abatilo/[email protected]
with:
poetry-version: 1.8.3
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: poetry
- name: Install dependencies
run: poetry install
- name: Check that documentation builds cleanly with MkDocs
run: poetry run mkdocs build -s
alexdewar marked this conversation as resolved.
Show resolved Hide resolved