Skip to content

Update README.md

Update README.md #383

Workflow file for this run

name: CI
on:
push:
branches:
- main
tags:
- v*
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name == 'workflow_dispatch' }}
cancel-in-progress: true
jobs:
lint:
name: lintrunner
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
python_version: ["3.9", "3.10", "3.11", "3.12"]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}
- name: Install dependencies
run: |
pip install poetry
poetry config virtualenvs.create false
poetry install
lintrunner init
- name: Run lintrunner on all files - Linux
if: matrix.os != 'windows-latest'
run: |
set +e
if ! lintrunner -v --force-color --all-files --tee-json=lint.json; then
echo ""
echo -e "\e[1m\e[36mYou can reproduce these results locally by using \`lintrunner -m main\`.\e[0m"
exit 1
fi
- name: Run lintrunner on all files - Windows
if: matrix.os == 'windows-latest'
run: lintrunner -v --force-color --all-files --skip NOQA,TABS,SPACES
- name: Store annotations
if: always() && github.event_name == 'pull_request' && matrix.os != 'windows-latest'
continue-on-error: true
run: |
# Use jq to massage the JSON lint output into GitHub Actions workflow commands.
jq --raw-output \
'"::\(if .severity == "advice" or .severity == "disabled" then "warning" else .severity end) file=\(.path),line=\(.line),col=\(.char),title=\(.code) \(.name)::" + (.description | gsub("\\n"; "%0A"))' \
lint.json
- name: Produce SARIF
if: always() && matrix.os == 'ubuntu-latest'
run: |
python -m lintrunner_adapters to-sarif lint.json lintrunner.sarif
- name: Upload SARIF file
if: always() && matrix.os == 'ubuntu-latest'
continue-on-error: true
uses: github/codeql-action/upload-sarif@v3
with:
# Path to SARIF file relative to the root of the repository
sarif_file: lintrunner.sarif
category: lintrunner
checkout_path: ${{ github.workspace }}
test:
name: pytest
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest]
python_version: ["3.8", "3.9", "3.10", "3.11"]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python_version }}
- name: Install dependencies
run: |
pip install poetry
pip install -r requirements-test.txt
poetry config virtualenvs.create false
poetry install
lintrunner init
- name: Run pytest
run: |
pytest lintrunner_adapters
env:
PY_IGNORE_IMPORTMISMATCH: 1
- name: Build package with poetry
run: |
poetry build
- name: Upload wheels
uses: actions/upload-artifact@v3
if: matrix.os == 'ubuntu-latest' && github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
with:
name: dist
path: dist
release:
name: Release
environment: PyPI
runs-on: ubuntu-latest
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
needs: [lint, test]
steps:
- uses: actions/download-artifact@v3
with:
name: dist
path: dist
- name: Publish package
uses: pypa/gh-action-pypi-publish@e53eb8b103ffcb59469888563dc324e3c8ba6f06
with:
password: ${{ secrets.PYPI_API_TOKEN }}