search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
83 stars 61 forks source link

Add a GH Action workflow to test this package against the latest mkdocs #97

Closed iamEAP closed 10 months ago

iamEAP commented 1 year ago

What / Why

An incompatibility was introduced in mkdocs v1.4.0 that broke TechDocs that made use of the monorepo plugin. This was caught in an end-to-end test in the Backstage monorepo (https://github.com/backstage/backstage/pull/13904). ...However it would be better to catch dependency incompatibility issues in this repo.

We should set up an action in this repository (ideally triggered anytime there is an mkdocs release, but if that's not possible, then perhaps just run daily) which attempts to build a fixture TechDocs site and runs some basic assertions on the output.

github-actions[bot] commented 10 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.