Skip to content

Migrate from buf's remote generation alpha #502

Migrate from buf's remote generation alpha

Migrate from buf's remote generation alpha #502

# ---------------------------------------------------------------------------- #
# Apache 2.0 License Copyright © 2022-2023 The Aurae Authors #
# #
# +--------------------------------------------+ #
# | █████╗ ██╗ ██╗██████╗ █████╗ ███████╗ | #
# | ██╔══██╗██║ ██║██╔══██╗██╔══██╗██╔════╝ | #
# | ███████║██║ ██║██████╔╝███████║█████╗ | #
# | ██╔══██║██║ ██║██╔══██╗██╔══██║██╔══╝ | #
# | ██║ ██║╚██████╔╝██║ ██║██║ ██║███████╗ | #
# | ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚══════╝ | #
# +--------------------------------------------+ #
# #
# Distributed Systems Runtime #
# #
# ---------------------------------------------------------------------------- #
# #
# 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. #
# #
# ---------------------------------------------------------------------------- #
#
# This will check the documentation (only).
#
# This build check will introduce confidence for the following:
#
# - That the documentation is updated and passes our spelling checks.
#
# When this build passes we should have confidence that our documentation is
# ready to be pushed to the website.
#
name: "Check docs (290) [aurae-builder:tester-latest]"
on:
push:
branches: main
pull_request:
branches: main
permissions:
contents: read
packages: write
env:
CARGO_TERM_COLOR: always
jobs:
build-container:
uses: ./.github/workflows/200-aurae-builder-image-docker-build-tester.yml
docs:
name: Build Docs
runs-on: ubuntu-latest
needs: build-container
container:
image: ghcr.io/${{ github.repository }}/aurae-builder:tester-latest
credentials:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3
- uses: actions/cache@v3
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: 200-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
200-${{ runner.os }}-cargo-
- name: Docs (make docs docs-lint)
run: |
make docs docs-lint