Currently we check that our docs build successfully when submitting a new PR. However maintainers are humans as well and can make errors, for example we can introduce a broken link in release notes. This will result in all new PRs failing because there's a broken link in the docs.
We can tackle this by adding the same action to the stable and beta release pipeline.
Our current action:
|
test_docs: |
|
if: github.repository_owner == 'pnp' |
|
runs-on: ubuntu-latest |
|
|
|
steps: |
|
- uses: actions/checkout@v3 |
|
- uses: actions/setup-python@v4 |
|
with: |
|
python-version: 3.x |
|
- run: pip install -r docs/pip_requirements.txt |
|
- run: mkdocs build --strict |
|
working-directory: docs |
Currently we check that our docs build successfully when submitting a new PR. However maintainers are humans as well and can make errors, for example we can introduce a broken link in release notes. This will result in all new PRs failing because there's a broken link in the docs.
We can tackle this by adding the same action to the stable and beta release pipeline.
Our current action:
cli-microsoft365/.github/workflows/check_pr.yml
Lines 114 to 125 in 4fefcde