Add docs and example to onboard new benchmarks #477
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 The OpenXLA Authors | |
| # | |
| # Licensed under the Apache License v2.0 with LLVM Exceptions. | |
| # See https://llvm.org/LICENSE.txt for license information. | |
| # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | |
| # Keep this in sync with devtools/scripts/lint.sh | |
| name: Lint | |
| on: [pull_request] | |
| jobs: | |
| yapf: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checking out repository | |
| uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0 | |
| - name: Setting up python | |
| uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4.5.0 | |
| - name: Fetching Base Branch | |
| # We have to explicitly fetch the base branch as well | |
| run: git fetch --no-tags --prune --depth=1 origin "${GITHUB_BASE_REF?}:${GITHUB_BASE_REF?}" | |
| - name: Install yapf | |
| run: | | |
| python3 -m pip install yapf==0.30.0 | |
| - name: Run format_diff.py with yapf | |
| run: | | |
| git diff -U0 "${GITHUB_BASE_REF?}" | python3 third_party/format_diff/format_diff.py yapf -i | |
| git diff --exit-code | |
| - name: Instructions for fixing the above linting errors | |
| if: failure() | |
| run: | | |
| printf "You can fix the lint errors above by running\n" | |
| printf " git diff -U0 "${GITHUB_BASE_REF?}" | python3 third_party/format_diff/format_diff.py yapf -i\n" | |
| pytype: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checking out repository | |
| uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0 | |
| - name: Setting up python | |
| uses: actions/setup-python@d27e3f3d7c64b4bbf8e4abfb9b63b83e846e0435 # v4.5.0 | |
| - name: Fetching Base Branch | |
| # We have to explicitly fetch the base branch as well | |
| run: git fetch --no-tags --prune --depth=1 origin "${GITHUB_BASE_REF?}:${GITHUB_BASE_REF?}" | |
| - name: Install pytype | |
| run: python3 -m pip install pytype | |
| - name: Run pytype on changed files | |
| run: ./devtools/scripts/check_pytype.sh "${GITHUB_BASE_REF?}" | |
| tabs: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checking out repository | |
| uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0 | |
| - name: Fetching Base Branch | |
| # We have to explicitly fetch the base branch as well | |
| run: git fetch --no-tags --prune --depth=1 origin "${GITHUB_BASE_REF?}:${GITHUB_BASE_REF?}" | |
| - name: Checking tabs | |
| run: ./devtools/scripts/check_tabs.sh "${GITHUB_BASE_REF?}" | |
| yamllint: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checking out repository | |
| uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0 | |
| - name: Fetching Base Branch | |
| # We have to explicitly fetch the base branch as well | |
| run: git fetch --no-tags --prune --depth=1 origin "${GITHUB_BASE_REF?}:${GITHUB_BASE_REF?}" | |
| - name: yamllint | |
| run: ./devtools/scripts/run_yamllint.sh "${GITHUB_BASE_REF?}" | |
| markdownlint: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Checking out repository | |
| uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3 # v3.5.0 | |
| - name: Downloading markdownlint | |
| run: npm install -g markdownlint-cli | |
| - name: Running markdownlint | |
| run: ./devtools/scripts/run_markdownlint.sh |