cit

Cit - controlarlo

Controle su código C ++ utilizando esta plantilla de integración continua.

CIT - es una plantilla de proyecto para el desarrollo de la base de código C ++. Agregue las líneas de análisis estáticas y dinámicas en la plantilla única, lista para usar.

Objetivos principales del proyecto

• Explore las capacidades de las herramientas automáticas y su impacto en el desarrollo

• Dar a los usuarios del Proyecto Acceso unificado a Linters y Herramientas de Análisis

• Mostrar técnicas de prueba diferentes propiedades de CodeBase

• Proporcionar compilaciones y entornos reproducibles a través de Docker y Nix

• Fomentar la actitud responsable hacia el desarrollo del software de calidad

Características

• Este repositorio proporciona entornos de desarrollo y prueba reproducibles con la fijación de la versión gracias a Docker y Nix

• Soporte de los principales compiladores de C ++, con todas las verificaciones de tiempo de compilación habilitadas

• Configuración de compilación multiplataforma familiar utilizando Cmake y Conan

• Pruebas de tiempo de ejecución con Doctest y desinfectantes

• Herramienta de línea de comandos para simplificar el uso de la funcionalidad

  

• Un montón de linters, formatters y herramientas de análisis estático integrados y configurados para cada aspecto del proyecto con informes informativos gracias a la integración con la versión parcheada de Megalinter

  

• No necesita mirar los registros de herramientas sin procesar, gracias a CodeChecker, puede verificar tablas de resumen, estadísticas de proyecto e informes en su navegador

• Incluso si no puede ejecutarlo localmente, eso no es un problema. Listo para usar la configuración de GitHub CI con las mismas verificaciones e informes cargados como artefactos

• Las solicitudes de extracción no se pasarán si las puntas encontraron algunos problemas

  

• ReviewDog Comentarios CPP Linters Salida en solicitud de extracción

  

• Las sugerencias y las soluciones automáticas de los revestimientos también se muestran mediante ReviewDog como sugerencias en la solicitud de extracción

  

• Solicite comentarios de solicitudes con resultados de pelusa como comentario: Ejemplo. Cuando no quedan problemas con PR, verá un mensaje actualizado desde BOT

  

• Cobertura de código con solicitudes de solicitud de extracción CODECOV

  

• Todos los artefactos con registros están disponibles para descargar desde CI

Estado actual

Este proyecto está en desarrollo, espere cambios en API, configuración y herramientas. Utiliza un conjunto obstinado de reglas y convenciones para el proyecto, no dude en cambiar los archivos de configuración para que mejor se ajuste a sus necesidades personales. Puede bifurcarse y jugar con él, las contribuciones al código fuente, los problemas y las solicitudes son bienvenidas.

Empezando

Puede usar esta plantilla en diferentes niveles de integración con el entorno de usuario. Desde el uso de Text Editor y ejecutar todas las verificaciones en CI, hasta el uso de Docker Image o Nix-Shell y la ejecución de la ejecución localmente.

1. Bifurca este proyecto, habilite las acciones de GitHub y edítelo con el editor de GitHub o con el editor de texto local

2. Proyecto Use Cmake Ninja y Conan. Si los tiene instalados en su sistema, puede construir y ejecutar pruebas como con cualquier otro proyecto CMake. O ejecute este script bash de Root of Project para construir Proyecto con GCC:

      ci/builders/gcc/build.sh

3. Para usar este proyecto localmente en todo el potencial, tiene opciones:

• Instale Docker de lo que puede usar la imagen de Docker preparada. Llame a este script desde Root of Project para ejecutar Bash Shell dentro de Docker Image

     ci/docker/run_shell.sh

• Instale el administrador de paquetes NIX o use NIXOS. En ese caso, llame a Nix-Shell

     nix-shell

Uso

Bueno. Obtienes tu entorno con imagen de Docker o con Nix-Shell, echemos un vistazo a lo que sigue. Para aliviar el uso del proyecto, usamos justo. Entonces podemos llamarlo así:

   just

Verá recetas disponibles (acciones) que puede hacer para usar el proyecto:

Exploremos las funciones principales. Puede crear un proyecto con GCC o CLANG COMPILER usando comandos:

   just build-gcc

   just build-clang

Para ejecutar todas las linters en el uso de su proyecto:

   just lint-all

Para ejecutar un enlace específico en su proyecto, use el comando de pelusa con el nombre del descriptor y el linter, todos los casos de capital divididos por subrayos. Entonces, si queremos ejecutar Clang-Tidy desde el descriptor CPP, llamamos:

   just lint-with CPP_CLANG_TIDY

Y veremos un informe de un solo linter:

Después de la pelusa, puede verificar la carpeta de informes con todos los registros desde los delineos.

De la imagen Nix-Shell o Docker también puede construir Docker Image usted mismo. Nix solía construir reproduciblemente el archivo de alquitrán con una imagen Docker que contiene todas las revestimientos

   just docker-build

Puede verificar que el resultado producido tiene la misma suma hash que el resultado producido por CI:

   sha256sum result

Imagen de Docker que cargada desde el resultado:

   just docker-load

O puede ejecutar Docker-Update-Localmente para hacer la creación de imágenes, Sha256sum y cargar en un solo comando:

   just docker-update-locally

El comando Docker-Update creará la imagen y la cargará en Docker-Hub:

   just docker-update

Para ver todos los trabajos internos, eche un vistazo a Just File para scripts de bash concretos para cada acción. Verifique el archivo de flujos de trabajo GitHub para obtener la configuración de GitHub CI.

Herramientas disponibles

• servicios en línea

  • Acciones de GitHub: comprobar/construir/ejecutar pruebas
  • CodeCov: verificar la cobertura de código de las pruebas
  • LGTM: construir y analizar el código fuente
  • dependabot: verifique las dependencias

• Comandos de consola unificados

  • Solo - CC0 1.0 Universal

• git

  • Git - GPLV2, LGPLV2.1
  • git -syer - MIT
  • conformar - MPL2.0
  • Compromiso - MIT
  • Gitlint - MIT
  • Git -Lint - Apache 2.0
  • Gitleaks - MIT

• licencias

  • Reutilización - Apache -2.0

• archivos y directorios

  • LS -Lint - MIT

• ortografía

  • CSPELL - MIT
  • Codespell - GPLV.2.0

• Análisis estático de CPP

  • Clang - Advertencias como verificaciones de errores - Apache 2.0
  • CLANG -FORMAT - NCSA
  • Clang -Tidy - NCSA
  • CPPCHECK - GPLV3.0
  • Cplint - BSD 3 Cláusula
  • GCC - Advertencias como verificaciones de errores - GPLV3.0

• Análisis dinámico de CPP

  • Clang - Desinfectantes - Apache 2.0
  • GCC - Desinfectantes - GPLV3.0
  • GRCOV - Cobertura de código - MPL -2.0

• CPP Ejemplos de uso de la biblioteca

  • Doctest - MIT
  • Resultado - Apache -2.0

• CMake

  • Cmake-formato GPLV3.0
  • CMake-Lint GPLV3.0

• caparazón

  • Shellcheck - GPLV3.0

• nada

  • nixpkgs-fmt-apache-2.0
  • Nix-Linter-BSD 3 Cláusula
  • NIX-Shell-Licencia LGPL-2.1

• archivos md

  • Comentario - MIT
  • TextLint - MIT

• yaml

  • Yamllint - GPLV3.0

Planificado

• Herramientas de CPP

  • JSCPD - MIT
  • Valgrind - GPLV2.0
  • libfuzzer - NCSA
  • Doxygen - GPLV2.0
  • Standardese - MIT
  • Mull - Apache -2.0
  • Mutate_CPP - MIT
  • RapidCheck-Cláusula BSD-2
  • Clazy - LGPLV2
  • inferir - MIT
  • PVS Studio

• compiladores de CPP

  • MSVC - Microsoft Eula
  • Mingw - GNU GPL

• entornos de CI

  • Macosa
  • Windows

• Ejemplos de uso de la biblioteca

  • QT6
  • OpenSSL - Apache -2.0
  • GSL -Lite - MIT

• prueba de GUI

  • Sikulix1 - MIT

• Pruebas de compilaciones reproducibles

  • Sha256sum - GPL -3.0

• Comandos de consola unificados

  • Husky - MIT

• prueba de aprobación

  • Aprobación tests.cpp - apache -2.0

• microbenchmarking

• Compilar Benchmarking

• wiki sobre el proyecto

• logotipo e ilustraciones

• Versiones y etiquetas de lanzamiento estable

• hoja de ruta

Créditos

Muchas gracias a los contribuyentes. Puedes ver contribuyentes en créditos.

Licencia

Plantilla CIT publicada bajo los términos de la licencia MIT. Vea la licencia para más información.