Repository navigation
Add Windows and macOS runners to the test matrix #3951
Workflow file for this run
This file contains hidden or 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: Check news fragments filenames, build documentation, check links, spelling, grammar, and style | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| # Build pull requests | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| - 'Makefile' | |
| - 'src/icalendar/*.py' | |
| - 'src/icalendar/cal/*.py' | |
| - 'src/icalendar/prop/*.py' | |
| - 'src/icalendar/timezone/*.py' | |
| - 'styles/**' | |
| - '.github/workflows/documentation.yml' | |
| - '.readthedocs.yaml' | |
| - '.vale.ini' | |
| - 'news/*.*' | |
| jobs: | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.11', '3.14'] | |
| steps: | |
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3 | |
| with: | |
| # UV_VERSION can be set in the repository settings: | |
| # Settings -> Secrets and variables -> Actions or click here: | |
| # https://github.com/PyCalendar/icalendar/settings/variables/actions | |
| # -> Variables -> UV_VERSION | |
| version: "${{ vars.UV_VERSION }}" | |
| - name: Create Python virtual environment, install requirements | |
| run: make .venv PYTHONVERSION=${{ matrix.python-version }} | |
| - name: Check news fragments filenames | |
| run: make changes-check PYTHONVERSION=${{ matrix.python-version }} | |
| - name: Build HTML documentation | |
| run: make html PYTHONVERSION=${{ matrix.python-version }} | |
| - name: Run vale | |
| run: make vale VALEOPTS="--minAlertLevel='warning'" PYTHONVERSION=${{ matrix.python-version }} | |
| - name: Check for broken links | |
| run: make linkcheckbroken PYTHONVERSION=${{ matrix.python-version }} |