deploy-doc-site.yml

# Copyright 2022 Aurora Operations, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: deploy-doc-site

on:
  push:
    branches:
      - main

jobs:
  deploy-doc-site:
    runs-on: ubuntu-latest

    permissions:
      contents: write

    steps:
      - uses: actions/checkout@dc323e67f16fb5f7663d20ff7941f27f5809e9b6 #v2.6.0
        with:
          # This will fetch all history for the repo: all branches and tags.  We
          # need this in order for `git describe` to work correctly when
          # creating the manifest for `au.hh` in the doc site.  However, as the
          # repo grows, this may become less ideal over time.
          #
          # It probably won't ever be a _hard_ blocker: the whole checkout step
          # currently takes 1 second, and we don't expect the repo to grow by
          # orders of magnitude.  That said, if there's ever a better
          # solution---say, the ability to fetch `main` back to the latest
          # tag---then it would be nice to switch to that someday.
          fetch-depth: 0

      - uses: fregante/setup-git-user@2e28d51939d2a84005a917d2f844090637f435f8 #v1.1.0

      - name: Build and deploy doc site
        run: bazel run //:mike -- deploy --push main