Add docgen all script and update documentation #7232
Workflow file for this run
This file contains 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
# Copyright 2023 Google LLC | |
# | |
# 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: Formatting Check (Run yarn format locally if this fails) | |
on: pull_request | |
env: | |
GITHUB_PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request.head.sha }} | |
GITHUB_PULL_REQUEST_BASE_SHA: ${{ github.event.pull_request.base.sha }} | |
jobs: | |
format: | |
name: Run license and prettier formatting tasks | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Repo | |
uses: actions/checkout@master | |
with: | |
# get all history for the diff | |
fetch-depth: 0 | |
- name: Set up node (20) | |
uses: actions/setup-node@v3 | |
with: | |
node-version: 20.x | |
- name: Yarn install | |
run: yarn | |
- name: Run formatting script | |
run: yarn format | |
- name: Check for changes (fail if so) | |
run: git diff --exit-code | |
- name: Formatting needs to be updated. See message below. | |
if: ${{ failure() }} | |
run: echo "Something was changed by formatting. Run \`yarn format\` locally to do a prettier/license pass. Use \`yarn format --help\` to see options." |