cit

CIT - ควบคุมมัน

ควบคุมรหัส C ++ ของคุณโดยใช้เทมเพลตการรวมอย่างต่อเนื่องนี้

CIT - เป็นเทมเพลตโครงการสำหรับการพัฒนา codebase C ++ มันรวมเครื่องมือการวิเคราะห์แบบคงที่และแบบไดนามิกในเดี่ยวพร้อมใช้เทมเพลต

เป้าหมายหลักของโครงการ

• สำรวจความสามารถของเครื่องมืออัตโนมัติและผลกระทบต่อการพัฒนา

• ให้ผู้ใช้ Project Unified Unified to linters และเครื่องมือวิเคราะห์

• เทคนิคการแสดงการทดสอบคุณสมบัติที่แตกต่างกันของ codebase

• จัดเตรียมการสร้างและสภาพแวดล้อมที่ทำซ้ำได้ผ่าน Docker และ Nix

• ส่งเสริมทัศนคติที่รับผิดชอบต่อการพัฒนาซอฟต์แวร์ที่มีคุณภาพ

คุณสมบัติ

• พื้นที่เก็บข้อมูลนี้ให้สภาพแวดล้อมการพัฒนาและทดสอบที่ทำซ้ำได้ด้วยการตรึงเวอร์ชันด้วย Docker และ Nix

• สนับสนุนคอมไพเลอร์ C ++ ที่สำคัญโดยเปิดใช้งานการตรวจสอบเวลาทั้งหมด

• การตั้งค่าการสร้างข้ามแพลตฟอร์มที่คุ้นเคยโดยใช้ CMake และ Conan

• การทดสอบรันไทม์กับ Doctest และ Sanitizers

• เครื่องมือบรรทัดคำสั่งเพื่อทำให้การใช้งานฟังก์ชันง่ายขึ้น

  

• ผ้าลินินจำนวนมาก formatters และเครื่องมือการวิเคราะห์แบบคงที่รวมและการตั้งค่าสำหรับแต่ละด้านของโครงการพร้อมรายงานข้อมูลด้วยการรวมเข้ากับ megalinter เวอร์ชันที่ได้รับการแก้ไข

  

• คุณไม่จำเป็นต้องจ้องที่บันทึกเครื่องมือดิบขอบคุณ CodeChecker คุณสามารถตรวจสอบตารางสรุปสถิติสำหรับโครงการและรายงานในเบราว์เซอร์ของคุณ

• แม้ว่าคุณจะไม่สามารถเรียกใช้งานได้ในพื้นที่ - นั่นไม่ใช่ปัญหา พร้อมที่จะใช้การตั้งค่า GitHub CI ด้วยการตรวจสอบและรายงานที่อัปโหลดเป็นสิ่งประดิษฐ์เดียวกัน

• คำขอดึงจะไม่ผ่านหาก Linters พบปัญหาบางอย่าง

  

• ReviewDog ความคิดเห็น CPP Linters เอาต์พุตในคำขอดึง

  

• คำแนะนำของ Linters และการแก้ไขอัตโนมัติจะแสดงโดย ReviewDog เป็นคำแนะนำในคำขอดึง

  

• ดึงการร้องขอความคิดเห็นพร้อมผลลัพธ์ผ้าสำลีเป็นความคิดเห็น: ตัวอย่าง เมื่อไม่มีปัญหาเหลืออยู่กับ PR คุณจะเห็นข้อความที่อัปเดตจากบอท

  

• การครอบคลุมรหัสพร้อมรายงานการร้องขอ PULL CODECOV

  

• สิ่งประดิษฐ์ทั้งหมดพร้อมบันทึกพร้อมดาวน์โหลดจาก CI

สถานะปัจจุบัน

โครงการนี้อยู่ระหว่างการพัฒนาคาดว่าจะมีการเปลี่ยนแปลงใน API การตั้งค่าและเครื่องมือ ใช้ชุดกฎและการประชุมที่มีความคิดเห็นสำหรับโครงการอย่าลังเลที่จะเปลี่ยนไฟล์การกำหนดค่าเพื่อให้เหมาะกับความต้องการส่วนบุคคลของคุณมากที่สุด คุณสามารถแยกและเล่นกับมันการมีส่วนร่วมในซอร์สโค้ดปัญหาและคำขอยินดีต้อนรับ

เริ่มต้น

คุณสามารถใช้เทมเพลตนี้ในระดับที่แตกต่างกันของการรวมเข้ากับสภาพแวดล้อมผู้ใช้ จากการใช้ตัวแก้ไขข้อความและเรียกใช้การตรวจสอบทั้งหมดใน CI ไปจนถึงการใช้อิมเมจนักเทียบท่าที่เตรียมไว้หรือ nix-shell และทำงานตรวจสอบในเครื่อง

1. แยกโครงการนี้เปิดใช้งานการกระทำของ GitHub และแก้ไขด้วยตัวแก้ไข GitHub หรือกับตัวแก้ไขข้อความท้องถิ่น

2. โครงการใช้ CMake Ninja และ Conan หากคุณติดตั้งไว้ในระบบของคุณคุณสามารถสร้างและเรียกใช้การทดสอบเช่นเดียวกับโครงการ CMake อื่น ๆ หรือเรียกใช้สคริปต์ทุบตีนี้จากรูทของโครงการเพื่อสร้างโครงการด้วย GCC:

      ci/builders/gcc/build.sh

3. หากต้องการใช้โครงการนี้ในพื้นที่อย่างเต็มศักยภาพที่คุณมีตัวเลือก:

• ติดตั้ง Docker มากกว่าที่คุณสามารถใช้ Image Docker ที่เตรียมไว้ เรียกสคริปต์นี้จากรูทของโครงการเพื่อเรียกใช้ Bash Shell ภายใน Image Docker

     ci/docker/run_shell.sh

• ติดตั้ง Nix Package Manager หรือใช้ NIXOS ในกรณีนั้นโทร Nix-Shell

     nix-shell

การใช้งาน

ตกลง. คุณได้รับสภาพแวดล้อมของคุณด้วยภาพ Docker หรือกับ Nix-Shell ลองมาดูกันว่ามีอะไรต่อไป เพื่อความสะดวกในการใช้งานโครงการที่เราใช้ ดังนั้นเราจึงเรียกได้ว่า:

   just

คุณจะเห็นสูตรอาหารที่มีอยู่ (การกระทำ) ซึ่งคุณสามารถทำได้เพื่อใช้โครงการ:

มาสำรวจฟังก์ชั่นหลักกันเถอะ คุณสามารถสร้างโครงการด้วยคอมไพเลอร์ GCC หรือ Clang โดยใช้คำสั่ง:

   just build-gcc

   just build-clang

ในการเรียกใช้ผ้าลินินทั้งหมดในการใช้งานโครงการของคุณ:

   just lint-all

ในการเรียกใช้ linter เฉพาะในโครงการของคุณให้ใช้คำสั่ง lint-with ที่มีชื่อของ descriptor และ linter ทั้งหมดแยกกรณีเงินทุนโดยการเน้นย้ำ ดังนั้นหากเราต้องการเรียกใช้การส่งสัญญาณจาก CPP Descriptor เราเรียกว่า:

   just lint-with CPP_CLANG_TIDY

และเราจะเห็นรายงานของ Linter เดี่ยว:

หลังจากผ้าสำลีคุณสามารถตรวจสอบโฟลเดอร์รายงานพร้อมบันทึกทั้งหมดจาก Linters

จาก Image Nix-Shell หรือ Docker คุณยังสามารถสร้างภาพนักเทียบท่าด้วยตัวเอง nix ใช้ในการสร้าง tar carchive ด้วยภาพนักเทียบท่าที่มีผ้าลินินทั้งหมด

   just docker-build

คุณสามารถตรวจสอบได้ว่าผลลัพธ์ที่ผลิตมีผลรวมแฮชเหมือนกันตามผลลัพธ์ที่ผลิตโดย CI:

   sha256sum result

อิมเมจนักเทียบท่ามากกว่าที่โหลดจากผลลัพธ์:

   just docker-load

หรือคุณสามารถเรียกใช้ Docker-update ในการสร้างภาพ, sha256sum และโหลดในคำสั่งเดียว:

   just docker-update-locally

คำสั่ง Docker-Update จะสร้างภาพและอัปโหลดไปยัง Docker-Hub:

   just docker-update

หากต้องการดูการทำงานภายในทั้งหมดให้ดูที่ JustFile สำหรับสคริปต์ Bash Concrete สำหรับการกระทำแต่ละครั้ง ตรวจสอบไฟล์เวิร์กโฟลว์ GitHub สำหรับการตั้งค่า GitHub CI

เครื่องมือที่มีอยู่

• บริการออนไลน์

  • การกระทำของ GitHub - ตรวจสอบ/สร้าง/เรียกใช้การทดสอบ
  • Codecov - ตรวจสอบความครอบคลุมของรหัสการทดสอบ
  • LGTM - สร้างและวิเคราะห์ซอร์สโค้ด
  • Inderbot - ตรวจสอบการพึ่งพา

• คำสั่งคอนโซลแบบครบวงจร

  • Just - CC0 1.0 Universal

• กระตวน

  • Git - GPLV2, LGPLV2.1
  • Git -Sizer - MIT
  • Conform - MPL2.0
  • commitlint - MIT
  • Gitlint - MIT
  • Git -Lint - Apache 2.0
  • Gitleaks - MIT

• ใบอนุญาต

  • นำกลับมาใช้ใหม่ - Apache -2.0

• ไฟล์และไดเรกทอรี

  • LS -LINT - MIT

• การสะกดคำ

  • CSPELL - MIT
  • codespell - gplv.2.0

• การวิเคราะห์แบบคงที่ CPP

  • เสียงดัง - คำเตือนเมื่อตรวจสอบข้อผิดพลาด - Apache 2.0
  • clang -format - NCSA
  • Clang -Tidy - NCSA
  • CPPCHECK - GPLV3.0
  • CPPLINT - BSD 3 -Clause
  • GCC - คำเตือนเมื่อตรวจสอบข้อผิดพลาด - GPLV3.0

• การวิเคราะห์แบบไดนามิก CPP

  • เสียงดัง - sanitizers - Apache 2.0
  • GCC - sanitizers - GPLV3.0
  • GRCOV - Code Coverage - MPL -2.0

• ตัวอย่างการใช้ห้องสมุด

  • Doctest - MIT
  • ผลลัพธ์ - Apache -2.0

• cmake

  • cmake-format gplv3.0
  • cmake-lint gplv3.0

• เปลือก

  • Shellcheck - GPLV3.0

• ห้าม

  • nixpkgs-fmt-apache-2.0
  • Nix-Linter-BSD 3-Clause
  • Nix-Shell-ใบอนุญาต LGPL-2.1

• ไฟล์ MD

  • คำพูด - MIT
  • TextLint - MIT

• ยม

  • Yamllint - GPLV3.0

วางแผน

• เครื่องมือ CPP

  • JSCPD - MIT
  • valgrind - gplv2.0
  • libfuzzer - NCSA
  • doxygen - gplv2.0
  • มาตรฐาน - MIT
  • Mull - Apache -2.0
  • Mutate_cpp - MIT
  • RapidCheck-BSD-2-Clause
  • Clazy - LGPLV2
  • อนุมาน - MIT
  • สตูดิโอ PVS

• คอมไพเลอร์ CPP

  • MSVC - Microsoft Eula
  • Mingw - GNU GPL

• สภาพแวดล้อม CI

  • แม็กอส
  • หน้าต่าง

• ตัวอย่างการใช้ห้องสมุด

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

• การทดสอบ GUI

  • Sikulix1 - MIT

• การทดสอบการสร้างที่ทำซ้ำได้

  • sha256sum - GPL -3.0

• คำสั่งคอนโซลแบบครบวงจร

  • ฮัสกี้ - MIT

• การทดสอบการอนุมัติ

  • Approvaltests.cpp - Apache-2.0

• microbenchmarking

• รวบรวมการเปรียบเทียบเวลา

• วิกิเกี่ยวกับโครงการ

• โลโก้และภาพประกอบ

• รุ่นและแท็กที่มีความเสถียร

• แผนงาน

การให้เครดิต

ขอบคุณมากสำหรับผู้มีส่วนร่วม คุณสามารถดูผู้มีส่วนร่วมในเครดิต

ใบอนุญาต

เทมเพลต CIT ที่ปล่อยออกมาภายใต้เงื่อนไขของใบอนุญาต MIT ดูใบอนุญาตสำหรับข้อมูลเพิ่มเติม