From fb3ccd36c031cfd695622ac2adf391a5d58d3758 Mon Sep 17 00:00:00 2001 From: Derek Bailey Date: Mon, 23 Dec 2024 16:04:15 -0800 Subject: [PATCH] `docs.yml` Add workflow for updating docs (#8462) --- .github/workflows/docs.yml | 33 +++++++++++++++++++++++++++++++++ .gitignore | 3 +++ 2 files changed, 36 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..1f35f2012 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,33 @@ +name: docs +on: + # For manual pushes. + workflow_dispatch: + + # Enable for whenever main gets updated. + # push: + # branches: + # - main + +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force -f docs/mkdocs.yml diff --git a/.gitignore b/.gitignore index 53ea7bba6..56203cde2 100644 --- a/.gitignore +++ b/.gitignore @@ -155,3 +155,6 @@ _deps/ kotlin/**/generated MODULE.bazel MODULE.bazel.lock + +# Ignore the generated docs +docs/site \ No newline at end of file