autoware-guideline-check

This package provides tools to check the Autoware contributing guidelines and other recommended conventions.

Features

• autoware-interface-check
• check-package-depends
• check-directory-structure

Command line tools

pip install git+https://github.com/autowarefoundation/autoware-guideline-check.git

GitHub Actions

name: autoware-guideline-check

on:
  pull_request:
  workflow_dispatch:

jobs:
  autoware-guideline-check:
    runs-on: ubuntu-22.04
    container: ros:humble-ros-core-jammy
    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Check out dependency
        run: |
          apt-get update && apt-get install -y python3-vcstool git
          mkdir -p dependency_ws
          vcs import dependency_ws < param_depends.repos
        shell: bash

      - name: Run autoware-guideline-check
        uses: autowarefoundation/[email protected]

pre-commit

repos:
  - repo: https://github.com/autowarefoundation/autoware-guideline-check
    rev: 0.2.0
    hooks:
      - id: check-package-depends
      - id: check-directory-structure