Update documentation about how to create a release (#6320) #317
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Test documentation | |
on: | |
pull_request: | |
paths: | |
- 'docs/guides/**' | |
- 'docs/checkstyle/check-docs.sh' | |
- '**.md' | |
push: | |
paths: | |
- 'docs/guides/**' | |
- 'docs/checkstyle/check-docs.sh' | |
- '**.md' | |
jobs: | |
# Check documentation with markdownlint and build it using mkdocs | |
documentation: | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: set up python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.9 | |
- name: install mkdocs | |
working-directory: docs/guides | |
run: pip install -q -r requirements.txt | |
- name: install javascript dependencies | |
working-directory: docs/guides | |
run: npm ci | |
- name: check documentation | |
run: ./docs/checkstyle/check-docs.sh |