Skip to content
Test

docs: add pre-commit note #18

Sign in to view logs

docs: add pre-commit note

docs: add pre-commit note #18

Workflow file for this run

.github/workflows/test.yml at a2bcdc4
# Runs several tests when a pull request is created.
name: Test
on:
pull_request:
jobs:
spell-check:
name: runner / misspell
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: reviewdog/action-misspell@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-check
level: warning
exclude: |
./CHANGELOG.md
alex: # Checks docs for inconsiderate writing.
name: runner / alex
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: reviewdog/action-alex@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-check
level: warning
markdown-lint: # Lints the markdown code.
name: runner / remark-lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check markdown code quality using remark-lint
uses: reviewdog/action-remark-lint@v5
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-check
level: warning
black: # Check python code format.
name: runner / black
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: reviewdog/action-black@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-check
level: warning
flake8: # Lints python code.
name: runner / flake8
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
token: ${{ secrets.GITHUB_TOKEN }}
- name: Set up Python environment
uses: actions/setup-python@v4
with:
python-version: 3.8
cache: pip
cache-dependency-path: |
**/requirements.txt
**/requirements/dev_requirements.txt
- name: Install the ros_gazebo_gym dev dependencies
run: |
pip install -r requirements/dev_requirements.txt
- name: flake8 Lint
uses: reviewdog/action-flake8@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-check
level: warning