Skip to content

Add assertion IDs that will be included in production log statements for fail and hardAsserts #4958

Add assertion IDs that will be included in production log statements for fail and hardAsserts

Add assertion IDs that will be included in production log statements for fail and hardAsserts #4958

Workflow file for this run

# 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: Doc Change Check (Run "yarn docgen:all" if this fails)
on: pull_request
jobs:
doc-check:
name: Check if reference docs have changed
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v4
with:
# get all history for the diff
fetch-depth: 0
- name: Set up Node (20)
uses: actions/setup-node@v4
with:
node-version: 22.10.0
- name: Yarn install
run: yarn
- name: Run doc generation
run: yarn docgen:all
# Fail first if there are docs-devsite changes since running yarn docgen:all
# will also regenerate any API report changes.
- name: Check for changes in docs-devsite dir (fail if so)
run: |
if [[ -n "$(git status docs-devsite --porcelain)" ]]; then
echo "Unstaged changes detected in docs-devsite/:"
git status -s
echo "Changes in this PR affect the reference docs or API reports. Run \`yarn docgen:all\` locally to regenerate the changed files and add them to this PR."
exit 1
fi
- name: Check for changes in common/api-review dir (fail if so)
run: |
if [[ -n "$(git status common/api-review --porcelain)" ]]; then
echo "Unstaged changes detected in api-report(s):"
git status -s
echo "Changes in this PR affect the API reports. Run \`yarn build\` locally to regenerate the API reports and add them to this PR."
exit 1
fi