diff --git a/.github/workflows/link-checker.yaml b/.github/workflows/link-checker.yaml new file mode 100644 index 000000000..6c3c37df6 --- /dev/null +++ b/.github/workflows/link-checker.yaml @@ -0,0 +1,30 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Check external links + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + mkdocs-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: byrnereese/github-action-mkdocs-link-check@v1 diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml index e32a31486..20bb26838 100644 --- a/.github/workflows/publish-docs.yaml +++ b/.github/workflows/publish-docs.yaml @@ -1,10 +1,27 @@ +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + name: Publish Docs + on: push: branches: - main + permissions: contents: write + jobs: deploy: runs-on: ubuntu-latest diff --git a/requirements.txt b/requirements.txt index e1c5ddd11..0cd7a6a39 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ -mkdocs-material==9.6.12 +mkdocs-material==9.6.14 mkdocs-redirects==1.2.2 +mkdocs-linkcheck==1.0.6