scribe-cli 0.5.1

Advanced code analysis and repository exploration library with AI-powered insights
Documentation
# GitHub Actions CI/CD

This repository includes a comprehensive CI/CD setup with multiple workflows to ensure code quality, security, and reliable releases.

## 🚀 Workflows

### 1. **Main CI Pipeline** (`.github/workflows/ci.yml`)
- **Triggers**: Push to main, Pull Requests
- **Features**:
  - Multi-platform testing (Ubuntu, Windows, macOS)
  - Multi-Rust version testing (stable, beta, nightly)
  - Comprehensive linting with Clippy
  - Code formatting checks with rustfmt
  - Full workspace testing (454 tests across all packages)
  - Code coverage reporting
  - Benchmark performance tracking
  - MSRV (Minimum Supported Rust Version) validation

### 2. **Security Audit** (`.github/workflows/security.yml`)
- **Triggers**: Push to main, Pull Requests, Weekly schedule
- **Features**:
  - Dependency vulnerability scanning with `cargo audit`
  - Supply chain security with `cargo deny`
  - Static analysis with CodeQL
  - Filesystem vulnerability scanning with Trivy
  - Security summary reporting

### 3. **Release Automation** (`.github/workflows/release.yml`)
- **Triggers**: Version tags (`v*.*.*`)
- **Features**:
  - Multi-platform binary builds (Linux, Windows, macOS, ARM)
  - Automated GitHub releases with assets
  - Crates.io publishing for stable releases
  - Docker image building and publishing
  - Cross-compilation support including musl targets

### 4. **Documentation** (`.github/workflows/docs.yml`)
- **Triggers**: Push to main, Pull Requests
- **Features**:
  - Comprehensive documentation building with `cargo doc`
  - GitHub Pages deployment
  - Documentation coverage reporting
  - Link checking and validation
  - Custom landing page generation

## 🛠️ Local Testing

You can test the CI workflows locally using [act](https://github.com/nektos/act):

```bash
# Test formatting
act push -j fmt

# Test clippy linting
act push -j clippy

# Test build verification
act push -j check

# Test full test suite
act push -j test
```

## 📊 Current Status

- **Total Tests**: 454 tests across all workspace packages
- **Test Success Rate**: 100% ✅
- **Code Coverage**: Comprehensive coverage across all modules
- **Security**: All known vulnerabilities addressed
- **Formatting**: All code properly formatted
- **Linting**: All clippy warnings resolved

## 🔧 Configuration

The workflows are configured with:
- Smart Cargo dependency caching for faster builds
- Proper error handling and reporting
- Security-first approach with comprehensive scanning
- Professional release automation
- Documentation-first development practices

## 📝 Maintenance

The CI/CD system automatically:
- Runs security audits weekly
- Updates documentation on every change
- Creates releases when version tags are pushed
- Maintains high code quality standards
- Provides detailed build and test reporting

All workflows follow Rust ecosystem best practices and provide enterprise-grade CI/CD capabilities.