Una acción de GitHub para el código C/C ++ que integra Clang-Tidy y Clang-Format para recopilar comentarios proporcionados en forma de file-annotations , thread-comments , flujo de trabajo step-summary y revisiones de solicitudes (con tidy-review o format-review ).
Advertencia
Solo admitimos corredores de Linux que usan un sistema operativo Linux con sede en Debian (como Ubuntu y muchos otros).
Los corredores de macOS y Windows también son compatibles.
Nota
Python 3.10 debe instalarse en la imagen Docker si su flujo de trabajo está ejecutando trabajos en un contenedor (ver discusión en el #185). Nuestra intención es sincronizar con la versión Python predeterminada incluida con los últimos lanzamientos de LTS de Ubuntu.
Cree un nuevo flujo de trabajo de GitHub Actions en su proyecto, por ejemplo, en .github/Workflows/CPP-Linter.yml
El contenido del archivo debe estar en el siguiente formato.
steps :
- uses : actions/checkout@v4
- uses : cpp-linter/cpp-linter-action@v2
id : linter
env :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
with :
style : ' file ' # Use .clang-format config file
tidy-checks : ' ' # Use .clang-tidy config file
# only 'update' a single comment in a pull request thread.
thread-comments : ${{ github.event_name == 'pull_request' && 'update' }}
- name : Fail fast?!
if : steps.linter.outputs.checks-failed > 0
run : exit 1Para obtener todas las explicaciones de nuestros parámetros de entrada y variables de salida disponibles, consulte nuestro documento de entradas y salidas.
Vea también nuestras recetas de ejemplo.
Uso file-annotations :
Para proporcionar comentarios (solicitar una función o informar un error), publique los problemas.
Los scripts y la documentación en este proyecto se publican bajo la licencia del MIT