deploy-docs.yml

name: deploy to mkdocs

# the two different ways to trigger the workflow
on:
  # enable manual trigger button in github actions web
  workflow_dispatch:

  # enable auto trigger based on both path and branch
  push:

    # only main branch
    branches:
      - main

    # at least one changed file must match this path
    paths:
      - "docs/**"

permissions:
  contents: write

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}
  cancel-in-progress: true

jobs:
  deploy:
    if: github.repository_owner == 'aws-samples'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: 3.x
          cache: pip
      - run: pip install mkdocs-material mkdocs-static-i18n==1.2.0
      - run: mkdocs gh-deploy --force