cit

CIT - Controle

Controle seu código C ++ usando este modelo de integração contínua.

CIT - é um modelo de projeto para o desenvolvimento da base de código C ++. Ele agrega liners, ferramentas de análise estática e dinâmica em modelo único, pronto para usar.

Principais objetivos do projeto

• Explore os recursos das ferramentas automáticas e seu impacto no desenvolvimento

• Dê aos usuários de acesso unificado do projeto a linheiros e ferramentas de análise

• Mostrar técnicas de teste diferentes propriedades da Base CodeBase

• Forneça construções e ambientes reprodutíveis através do Docker e Nix

• Incentive a atitude responsável em relação ao desenvolvimento de software de qualidade

Características

• Este repositório fornece ambientes de desenvolvimento e teste reprodutíveis com fixação de versões graças ao Docker e Nix

• Suporte dos principais compiladores C ++, com todas as verificações de tempo de compilação ativadas

• Configuração familiar de construção entre plataformas cruzadas usando CMake e Conan

• Testes de tempo de execução com Doctest e desinfetantes

• Ferramenta de linha de comando para simplificar o uso da funcionalidade

  

• Muitos liners, formates e ferramentas de análise estática integradas e configuradas para cada aspecto do projeto com relatórios informativos, graças à integração com a versão corrigida do megalinter

  

• Você não precisa olhar para os registros de ferramentas brutos, graças ao Codechecker Você pode verificar as tabelas de resumo, estatísticas de projeto e relatórios no seu navegador

• Mesmo se você não conseguir executá -lo localmente - isso não é um problema. Pronto para usar a configuração do GitHub CI com as mesmas verificações e relatórios enviados como artefatos

• Solicitações de tração não passam se os linheiros encontrarem alguns problemas

  

• REVISÃO COMENTÁRIOS DOG LIVERS CPP SAÍDA EM PULL SPILD

  

• As sugestões de linters e as correções automáticas também são exibidas pelo ReviewDog como sugestões na solicitação de tração

  

• Puxe solicita feedback com resultados de linha como comentário: Exemplo. Quando não há problemas com o PR, você verá uma mensagem atualizada do bot

  

• Cobertura de código com Relatórios de Codecov Pull Pull Solic

  

• Todos os artefatos com logs estão disponíveis para download de CI

Status atual

Este projeto está em desenvolvimento, espere alterações na API, configuração e ferramentas. Ele usa conjunto opinativo de regras e convenções para o projeto, sinta -se à vontade para alterar os arquivos de configuração para melhor atender às suas necessidades pessoais. Você pode gastar e brincar com ele, contribuições para o código -fonte, os problemas e solicitações são bem -vindos.

Começando

Você pode usar esse modelo em diferentes níveis de integração com o ambiente do usuário. Ao usar o editor de texto e a execução de todas as verificações no CI, até o uso da imagem do docker preparada ou o nix-shell e a execução da verificação localmente.

1. Fork este projeto, ative ações do GitHub e edite -o com o editor do GitHub ou com o editor de texto local

2. Uso do projeto CMake Ninja e Conan. Se você os tiver instalado no seu sistema, poderá criar e executar testes como em qualquer outro projeto CMake. Ou execute este script bash da raiz do projeto para construir o projeto com o GCC:

      ci/builders/gcc/build.sh

3. Para usar este projeto localmente para todo o potencial, você tem opções:

• Instale o Docker do que você pode usar a imagem preparada do Docker. Chame esse script da raiz do projeto para executar o Bash Shell dentro da imagem do Docker

     ci/docker/run_shell.sh

• Instale o NIX Package Manager ou use nixos. Nesse caso, ligue para Nix-Shell

     nix-shell

Uso

OK. Você tem seu ambiente com a imagem do Docker ou com o Nix-Shell, vamos dar uma olhada no que vem a seguir. Para facilitar o uso do projeto, usamos apenas. Então, podemos chamá -lo assim:

   just

Você verá receitas (ações) disponíveis para usar o Projeto:

Vamos explorar as principais funções. Você pode construir o projeto com compilador GCC ou CLANG usando comandos:

   just build-gcc

   just build-clang

Para executar todos os linhtos no uso do seu projeto:

   just lint-all

Para executar o Linter específico no seu projeto, use o comando lint-with com o nome do descritor e Linter All Capital Case dividido por sublinhados. Então, se queremos executar o Clang-Tidy a partir do descritor de CPP, chamamos:

   just lint-with CPP_CLANG_TIDY

E veremos o relatório de um único Linter:

Após o linhagem, você pode verificar a pasta de relatório com todos os logs dos linheiros.

Da imagem Nix-Shell ou Docker, você também pode criar uma imagem do Docker. Nix usado para criar o arquivo alcatrão reprodutível com a imagem do docker contendo todos os linters

   just docker-build

Você pode verificar se o resultado produzido tem a mesma soma de hash que o resultado produzido pelo CI:

   sha256sum result

Imagem do docker do que carregado do resultado:

   just docker-load

Ou você pode executar o Docker-Update localmente para fazer a criação de imagens, SHA256SUM e carregar no comando único:

   just docker-update-locally

Docker-update Command criará imagem e o enviará para Docker-Hub:

   just docker-update

Para ver todos os trabalhos internos, dê uma olhada no JustFile para scripts de bash de concreto para cada ação. Verifique o arquivo dos fluxos de trabalho do GitHub para obter a configuração do GitHub CI.

Ferramentas disponíveis

• Serviços online

  • Ações do GitHub - Testes de verificação/construção/execução
  • Codecov - Verifique a cobertura do código dos testes
  • LGTM - Construa e analise o código -fonte
  • DependBot - Verifique as dependências

• Comandos de console unificado

  • Just - CC0 1.0 Universal

• git

  • Git - GPLV2, LGPLV2.1
  • Git -Sizer - MIT
  • conforme - mpl2.0
  • COMMITLINT - MIT
  • Gitlint - MIT
  • Git -Lint - Apache 2.0
  • GitLeaks - MIT

• licenças

  • Reutilização - Apache -2.0

• arquivos e diretórios

  • LS -Lint - MIT

• ortografia

  • CSPELL - MIT
  • Codesell - GPLV.2.0

• Análise estática do CPP

  • Clang - avisos como erros verificações - Apache 2.0
  • Formato de Clang - NCSA
  • Clang -Tidy - NCSA
  • CPPCHECK - GPLV3.0
  • CPPLINT - BSD 3 -cláusulas
  • GCC - AVISOS AS ERROS CHECHES - GPLV3.0

• Análise dinâmica do CPP

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

• Exemplos de CPP de uso da biblioteca

  • Doctest - MIT
  • Resultado - Apache -2.0

• cmake

  • GPLV3.0 de formato cmake
  • CMake-LINT GPLV3.0

• concha

  • shellcheck - GPLV3.0

• nix

  • nixpkgs-fmt-Apache-2.0
  • Nix-Linter-BSD 3-cláusula
  • Nix-Shell-Licença LGPL-2.1

• Arquivos MD

  • Observação - MIT
  • Textlint - MIT

• Yaml

  • Yamllint - GPLV3.0

Planejado

• Ferramentas CPP

  • JSCPD - MIT
  • Valgrind - GPLV2.0
  • Libfuzzer - NCSA
  • Doxygen - GPLV2.0
  • Standardese - MIT
  • Mull - Apache -2.0
  • Mutate_cpp - MIT
  • RapidCheck-BSD-2-cláusula
  • CLAZY - LGPLV2
  • inferir - mit
  • PVS Studio

• Compiladores de CPP

  • MSVC - Microsoft Eula
  • Mingw - GNU GPL

• Ambientes CI

  • Macos
  • Windows

• Exemplos de uso da biblioteca

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

• Teste da GUI

  • Sikulix1 - MIT

• Reproduzível compra testes

  • SHA256SUM - GPL -3.0

• Comandos de console unificado

  • Husky - MIT

• Teste de aprovação

  • AprovaçãoTests.cpp - Apache -2.0

• Microbenchmarking

• Compilar o benchmarking do tempo

• Wiki sobre o projeto

• Logotipo e ilustrações

• Versões e tags de liberação estável

• roteiro

Créditos

Muito obrigado aos colaboradores. Você pode ver colaboradores em créditos.

Licença

Modelo CIT divulgado sob os termos da licença do MIT. Consulte a licença para obter mais informações.