cit

Cit - le contrôler

Contrôlez votre code C ++ à l'aide de ce modèle d'intégration continue.

CIT - est un modèle de projet pour le développement de la base de code C ++. Il agrége les liners, les outils d'analyse statique et dynamique dans un modèle unique et prêt à l'emploi.

Objectifs principaux du projet

• Explorez les capacités des outils automatiques et leur impact sur le développement

• Donnez aux utilisateurs de l'accès unifié du projet aux liners et aux outils d'analyse

• Présenter des techniques de test de différentes propriétés de la base de code

• Fournir des versions et des environnements reproductibles via Docker et Nix

• Encouragez une attitude responsable envers le développement de logiciels de qualité

Caractéristiques

• Ce référentiel fournit des environnements de développement et de test reproductibles avec la version épingle grâce à Docker et Nix

• Prise en charge des principaux compilateurs C ++, avec toutes les vérifications de temps de compilation activées

• Configuration familière de construction multiplateforme à l'aide de CMake et Conan

• Tests d'exécution avec Doctest et désinfectants

• Outil de ligne de commande pour simplifier l'utilisation des fonctionnalités

  

• Beaucoup de linceurs, de formateurs et d'outils d'analyse statique intégrés et configurés pour chaque aspect du projet avec des rapports informatifs grâce à l'intégration avec la version patchée de Megaliter

  

• Vous n'avez pas besoin de regarder les journaux bruts des outils, grâce à CodeChecker, vous pouvez vérifier les tables de résumé, les statistiques pour le projet et les rapports dans votre navigateur

• Même si vous ne pouvez pas l'exécuter localement - ce n'est pas un problème. Configuration de GitHub CI prête avec les mêmes vérifications et rapports téléchargés sous forme d'artefacts

• Les demandes de traction ne passeront pas si les liners trouvaient des problèmes

  

• ReviewDog Commentaires CPP Liners Sortie dans la demande de traction

  

• Les suggestions de liners et les correctifs automobiles sont également affichés par ReviewDog comme suggestions dans la demande de traction

  

• Tirez les demandes des commentaires avec les résultats de liaison comme commentaire: Exemple. Lorsqu'il ne reste plus de problèmes avec PR, vous verrez le message mis à jour de Bot

  

• Couverture de code avec requête Pull Rapports de codecov

  

• Tous les artefacts avec des journaux sont disponibles en téléchargement depuis CI

État actuel

Ce projet est en cours de développement, attendez des changements dans l'API, la configuration et les outils. Il utilise un ensemble d'opinion de règles et de conventions pour le projet, n'hésitez pas à modifier les fichiers de configuration pour répondre au mieux à vos besoins personnels. Vous pouvez déborder et jouer avec elle, les contributions au code source, les problèmes et les demandes sont les bienvenues.

Commencer

Vous pouvez utiliser ce modèle à différents niveaux d'intégration avec l'environnement utilisateur. De l'utilisation de l'éditeur de texte et de l'exécution de toutes les vérifications dans CI, jusqu'à l'utilisation de l'image Docker préparée ou de la shell Nix et de la vérification en cours d'exécution localement.

1. Fourk ce projet, activez les actions GitHub et modifiez-la avec GitHub Editor ou avec l'éditeur de texte local

2. Utiliser le projet Cmake Ninja et Conan. Si vous les avez installés sur votre système, vous pouvez créer et exécuter des tests comme pour tout autre projet CMake. Ou exécutez ce script bash de Root of Project to Build Project avec GCC:

      ci/builders/gcc/build.sh

3. Pour utiliser ce projet localement au plein potentiel, vous avez des options:

• Installez Docker que vous pouvez utiliser l'image Docker préparée. Appelez ce script de Root of Project to Run Bash Shell à l'intérieur de l'image Docker

     ci/docker/run_shell.sh

• Installez Nix Package Manager ou utilisez Nixos. Dans ce cas, appelez Nix-Shell

     nix-shell

Usage

D'accord. Vous avez votre environnement avec Docker Image ou avec Nix-Shell, jetons un coup d'œil à la suite. Pour faciliter l'utilisation du projet, nous utilisons juste. Nous pouvons donc l'appeler comme ça:

   just

Vous verrez des recettes (actions) disponibles que vous pouvez faire pour utiliser le projet:

Explorons les fonctions principales. Vous pouvez créer un projet avec GCC ou Clang Compiler à l'aide de commandes:

   just build-gcc

   just build-clang

Pour exécuter tous les liners sur votre utilisation de projet:

   just lint-all

Pour exécuter un linter spécifique sur votre projet, utilisez la commande de peluche avec le nom de Descripteur et Linter Tous les cas de capital divisés par soulignements. Donc, si nous voulons exécuter Clang-tidy à partir du descripteur CPP, nous appelons:

   just lint-with CPP_CLANG_TIDY

Et nous verrons un rapport de linter unique:

Après avoir lié, vous pouvez vérifier le dossier de rapport avec tous les journaux de liners.

À partir de l'image Nix-Shell ou Docker, vous pouvez également créer vous-même Docker Image. Nix a l'habitude de construire de manière reproductible des archives TAR avec une image Docker contenant tous les liners

   just docker-build

Vous pouvez vérifier que le résultat produit a la même somme de hachage que le résultat produit par CI:

   sha256sum result

Image docker que chargée du résultat:

   just docker-load

Ou vous pouvez exécuter docker-update-local pour faire la création d'images, sha256sum et charger en commande unique:

   just docker-update-locally

La commande docker-update créera une image et la téléchargera sur docker-hub:

   just docker-update

Pour voir tous les travaux intérieurs, jetez un coup d'œil à JustFile pour les scripts de bash de béton pour chaque action. Vérifiez le fichier GitHub Workflows pour la configuration GitHub CI.

Outils disponibles

• services en ligne

  • Actions GitHub - Vérifier / construire / exécuter les tests
  • CodeCov - Vérifiez la couverture du code des tests
  • LGTM - Créer et analyser le code source
  • DependAbot - Vérifiez les dépendances

• Commandes de console unifiées

  • Juste - CC0 1.0 Universal

• git

  • git - gplv2, lgplv2.1
  • git-sizer - MIT
  • conforme - MPL2.0
  • commissaire - MIT
  • Gitlint - MIT
  • git-lint - Apache 2.0
  • gitleaks - mit

• licence

  • Réutilisation - Apache-2.0

• Fichiers et répertoires

  • LS-lint - MIT

• orthographe

  • CSpell - MIT
  • Codespell - GPLV.2.0

• Analyse statique CPP

  • Clang - Avertissements comme vérification des erreurs - Apache 2.0
  • Clang-Format - NCSA
  • Clang-tidy - NCSA
  • CPPCHECK - GPLV3.0
  • Cpplint - BSD 3-CLAUSE
  • GCC - Avertissements comme vérification des erreurs - GPLV3.0

• Analyse dynamique CPP

  • Clang - Sanitizers - Apache 2.0
  • GCC - désinfectants - GPLV3.0
  • Grcov - Couverture du code - MPL-2.0

• CPP Exemples d'utilisation de la bibliothèque

  • Doctst - MIT
  • Résultat - Apache-2.0

• cmake

  • CMake-Format GPLV3.0
  • cmake-lint gplv3.0

• coquille

  • Shellcheck - GPLV3.0

• rien

  • Nixpkgs-fmt - Apache-2.0
  • NIX-LINTER - BSD 3-CLAUSE
  • Licence Nix-Shell - LGPL-2.1

• Fichiers MD

  • Remarque - MIT
  • Textlint - MIT

• yaml

  • Yamllint - gplv3.0

Prévu

• Outils CPP

  • JSCPD - MIT
  • Valgrind - GPLV2.0
  • libfuzzer - ncsa
  • doxygen - gplv2.0
  • Standardais - MIT
  • Mull - Apache-2.0
  • Mutate_cpp - MIT
  • RapidCheck - BSD-2-CLAUSE
  • CLAZY - LGPLV2
  • inférer - mit
  • Studio PVS

• compilateurs CPP

  • MSVC - Microsoft Eula
  • Mingw - GNU GPL

• Environnements CI

  • Macos
  • Fenêtre

• Exemples d'utilisation de la bibliothèque

  • qt6
  • OpenSSL - Apache-2.0
  • GSL-LITE - MIT

• Test de l'interface graphique

  • Sikulix1 - MIT

• Test de construction reproductible

  • Sha256Sum - GPL-3.0

• Commandes de console unifiées

  • husky - mit

• tests d'approbation

  • Approbationtests.cpp - apache-2.0

• microbenchare

• compiler le temps d'analyse

• Wiki sur le projet

• logo et illustrations

• Versions et balises de version stable

• feuille de route

Crédits

Un grand merci aux contributeurs. Vous pouvez voir des contributeurs en crédits.

Licence

Modèle CIT publié selon les termes de la licence MIT. Voir la licence pour plus d'informations.