🚀 hf-general-ci-tools

A comprehensive collection of reusable GitHub Actions workflows for modern CI/CD pipelines

Streamline your development workflow with battle-tested, production-ready GitHub Actions

📋 Overview

This repository provides a curated set of reusable GitHub Actions workflows designed to accelerate your CI/CD pipeline setup. Whether you’re working on C/C++ projects, documentation, or need comprehensive quality checks, these workflows have you covered.

📖 📚🌐 Live Complete Documentation - Interactive guides, examples, and step-by-step tutorials

✨ Key Features

🔧 C/C++ Development - Linting, static analysis, and code quality
📚 Documentation - Doxygen generation and GitHub Pages deployment
🔗 Link Validation - Comprehensive link checking for documentation
📝 YAML Validation - Ensure your workflow files are properly formatted
🎯 Production Ready - Battle-tested workflows used in real projects
⚙️ Highly Configurable - Extensive customization options
🚀 Easy Integration - Drop-in workflows for immediate use

🔄 Reusable Workflows

For other repositories - These workflows are designed to be called from your own repositories

Workflow	Description	Features	Quick Start
🔧 C/C++ Lint	Code quality and formatting checks	• clang-format • clang-tidy • Configurable rules	→ Use Now
🛡️ Static Analysis	Security and bug detection	• cppcheck integration • Custom rules • Multiple standards	→ Use Now
📚 Documentation	Documentation generation & deployment	• Doxygen support • Jekyll sites • GitHub Pages	→ Use Now
🔗 Link Check	Documentation link validation	• Lychee integration • Custom configs • Exclude patterns	→ Use Now
📝 YAML Lint	YAML file validation	• Syntax checking • Style validation • Custom rules	→ Use Now

🏠 Repository-Specific Workflows

Internal workflows - These are used by this repository itself.

Workflow	Purpose	Trigger	Status
📚 Publish Documentation	Builds and deploys this repo’s documentation site	Push to main, PRs	✅ Active
📝 YAML Lint	Validates YAML syntax in this repository	Push, PRs	✅ Active

📚 Documentation

🌐 Live Documentation Site
Published documentation with enhanced navigation and search

📖 Available Guides

Guide	Description	Target Audience
📋 Documentation Index	Complete overview and navigation	All users
🔧 C/C++ Lint Guide	Code quality and formatting setup	C/C++ developers
🛡️ Static Analysis Guide	Security analysis configuration	Security-focused teams
📚 Documentation Guide	Documentation generation & deployment	Documentation teams
🔗 Link Check Guide	Link validation setup	Documentation maintainers
📝 YAML Lint Guide	YAML validation configuration	DevOps engineers
💡 Example Workflows	Complete workflow examples	All users

🚀 Quick Start

📚 View Complete Documentation - Interactive guides, examples, and configuration templates

🎯 Using Reusable Workflows

For other repositories - Copy and customize these examples for your project

🔧 Basic CI Pipeline

name: 🚀 CI Pipeline
on:
  push: { branches: [ main ] }
  pull_request: { branches: [ main ] }

jobs:
  # Code quality checks
  lint:
    uses: n3b3x/hf-general-ci-tools/.github/workflows/c-cpp-lint.yml@v1
    with:
      clang_version: "20"
      style: "file"
      extensions: "c,cpp,h,hpp"

  # Security analysis
  static:
    uses: n3b3x/hf-general-ci-tools/.github/workflows/c-cpp-static-analysis.yml@v1
    with:
      paths: "src include"
      std: "c++17"
      strict: false

  # Documentation generation
  docs:
    uses: n3b3x/hf-general-ci-tools/.github/workflows/docs.yml@v1
    with:
      doxygen_config: "Doxyfile"
      output_dir: "docs/doxygen/html"

  # Link validation
  link-check:
    uses: n3b3x/hf-general-ci-tools/.github/workflows/docs-link-check.yml@v1
    with:
      paths: "docs/**,*.md"

🎨 Individual Workflow Examples

🔧 C/C++ Linting Only

```yaml name: Code Quality on: [push, pull_request] jobs: lint: uses: n3b3x/hf-general-ci-tools/.github/workflows/c-cpp-lint.yml@v1 with: source_dirs: "src/" include_patterns: "*.cpp,*.hpp,*.c,*.h" clang_version: "20" style: "file" ```

📚 Documentation Only

```yaml name: Build Docs on: [push] jobs: docs: uses: n3b3x/hf-general-ci-tools/.github/workflows/docs.yml@v1 with: jekyll_enabled: true jekyll_source: "docs" deploy_pages: true run_link_check: true ```

🔗 Link Checking Only

```yaml name: Check Links on: [push, pull_request] jobs: link-check: uses: n3b3x/hf-general-ci-tools/.github/workflows/docs-link-check.yml@v1 with: paths: "docs/**,*.md" verbose: true timeout: "30" ```

📋 Prerequisites

✅ Required Setup

Requirement	Description	Example
GitHub Actions	Enabled in your repository	Repository Settings → Actions
Project Structure	Proper C/C++ project layout	`src/`, `include/`, `docs/`
Configuration Files	Tool-specific configs	`.clang-format`, `Doxyfile`

🏗️ Recommended Project Structure

your-awesome-project/
├── .github/workflows/          # Your CI workflows
│   └── ci.yml                  # Main CI pipeline
├── src/                        # Source code
│   ├── main.cpp
│   └── utils/
├── include/                    # Header files
│   └── utils.h
├── docs/                       # Documentation
│   ├── index.md
│   └── api/
├── .clang-format              # Code style configuration
├── .clang-tidy                # Static analysis configuration
├── Doxyfile                   # Documentation configuration
├── .yamllint                  # YAML linting configuration
└── README.md                  # Project documentation

📚 Official Documentation

Tool	Documentation	Purpose
GitHub Actions	Official GitHub Actions docs	Workflow syntax and features
Clang Format	Code formatting tool	Style configuration
Cppcheck	Static analysis tool	Bug and security detection
Doxygen	Documentation generator	API documentation
Jekyll	Static site generator	Documentation websites

🛠️ Configuration Examples

Configuration Examples - Ready-to-use config files
Example Workflows - Complete workflow examples

📄 License

GNU General Public License v3.0 - See the LICENSE file for details

Free for personal and commercial use

🧪 Test 404 Page - (on live documentation) Click this link to test our custom 404 page!

⭐ Star this repository if you find it helpful!

Report Bug • Request Feature • Contribute