Repository navigation
feat(source/gateway-api): add Gateway resource source #576
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: Docs | |
| on: | |
| pull_request: | |
| branches: | |
| - master | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - ".github/workflows/docs.yaml" | |
| # See https://docs.github.com/fr/webhooks/webhook-events-and-payloads#workflow_dispatch | |
| # Can be used to update doc with latest tag | |
| workflow_dispatch: | |
| inputs: | |
| tag: | |
| description: "Build documentation for specified tag value" | |
| required: true | |
| type: string | |
| permissions: {} | |
| jobs: | |
| build_docs: | |
| name: Lint Docs | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'pull_request' | |
| steps: | |
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| cache-dependency-path: "./docs/scripts/requirements.txt" | |
| # To update dependencies, edit docs/scripts/requirements.in and run: | |
| # pip-compile --generate-hashes --strip-extras --output-file=docs/scripts/requirements.txt docs/scripts/requirements.in | |
| - run: pip install --require-hashes -r docs/scripts/requirements.txt | |
| - name: lint and build docs | |
| run: mkdocs build --strict | |
| release_docs: | |
| permissions: | |
| contents: write # for mike to push | |
| name: Release Docs | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'workflow_dispatch' | |
| steps: | |
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| cache-dependency-path: "./docs/scripts/requirements.txt" | |
| - run: pip install --require-hashes -r docs/scripts/requirements.txt | |
| - name: Configure Git user | |
| run: | | |
| git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
| git config --local user.name "github-actions[bot]" | |
| - name: build and push | |
| run: | | |
| VERSION="${{ inputs.tag }}" | |
| mike deploy $VERSION latest --push --update-aliases | |
| mike set-default --push latest |