Skip to content

docs: extract mkdocs deps to requirements.txt and validate build on PRs#99

Merged
clementnuss merged 3 commits into
postfinance:mainfrom
ci7rix:docs-copy-paste
Jun 22, 2026
Merged

docs: extract mkdocs deps to requirements.txt and validate build on PRs#99
clementnuss merged 3 commits into
postfinance:mainfrom
ci7rix:docs-copy-paste

Conversation

@ci7rix

@ci7rix ci7rix commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

The documentation dependencies (mkdocs-material, mdx-truly-sane-lists, mike) were hardcoded in the docs.yml workflow, with nothing to install them locally. This PR moves them into docs/requirements.txt and points the workflow at it, so CI and local setups share a single source of truth.

It also adds a pull_request trigger filtered on docs/**, mkdocs.yml and the workflow, along with a mkdocs build --strict step, so a broken docs build gets caught at PR time rather than after merge. The mike deploy steps now sit behind if: github.ref == 'refs/heads/main', which keeps deployment on main while letting PRs run the build without publishing anything.

Finally, it enables content.code.copy in mkdocs.yml. The code blocks had no copy button, which made commands awkward to select by hand and prone to picking up stray characters.

@clementnuss

Copy link
Copy Markdown
Contributor

thanks! that's helpful 🙃

@clementnuss clementnuss merged commit 6c4328d into postfinance:main Jun 22, 2026
3 checks passed
eleboucher pushed a commit to eleboucher/homelab that referenced this pull request Jun 23, 2026
…1240)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [github:postfinance/topf](https://github.com/postfinance/topf) | patch | `0.4.1` → `0.4.2` |

---

### Release Notes

<details>
<summary>postfinance/topf (github:postfinance/topf)</summary>

### [`v0.4.2`](https://github.com/postfinance/topf/releases/tag/v0.4.2)

[Compare Source](postfinance/topf@v0.4.1...v0.4.2)

#### \[0.4.2] - 2026-06-22

##### Features

- Concurrent upgrade/apply with --max-parallel=... flag ([c0bebc7](postfinance/topf@c0bebc7))

##### Documentation

- Fixed typo 'you cluster' to 'your cluster' in documentation ([66f0e32](postfinance/topf@66f0e32))
- Improve README.md and getting-started example ([df22bb6](postfinance/topf@df22bb6))
- Extract mkdocs deps to requirements.txt and validate build on PRs ([#&#8203;99](postfinance/topf#99)) ([6c4328d](postfinance/topf@6c4328d))

##### Miscellaneous

- Update changelog ([c85d2f1](postfinance/topf@c85d2f1))

##### Build

- **gh-actions**: Pin gh actions ([af6fbfb](postfinance/topf@af6fbfb))
- **deps**: Bump golangci/golangci-lint-action ([#&#8203;97](postfinance/topf#97)) ([589b417](postfinance/topf@589b417))
- **deps**: Bump actions/checkout from 6.0.3 to 7.0.0 ([#&#8203;98](postfinance/topf#98)) ([2b2ac2c](postfinance/topf@2b2ac2c))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xMDEuMSIsInVwZGF0ZWRJblZlciI6IjQzLjEwMS4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJyZW5vdmF0ZS9naXRodWItcmVsZWFzZSIsInR5cGUvcGF0Y2giXX0=-->

Reviewed-on: https://git.erwanleboucher.dev/eleboucher/homelab/pulls/1240
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