finishing-bot: Release Readiness Validator

Contents

• 1. Overview
  • 1.1. Key Features
• 2. Use Cases
• 3. Installation
  • 3.1. Configuration
  • 3.2. Automation with Just
• 4. Usage
• 5. Configuration
• 6. Documentation
• 7. Integration with repo-care
• 8. License
• 9. Community
• 10. Relationship to Gitbot Fleet
• 11. Security

1. Overview

finishing-bot is a release readiness validation bot in the Hyperpolymath ecosystem. It ensures repositories are production-ready by:

• Removing placeholders (e.g., TODO, FIXME).

• Validating licenses and compliance.

• Verifying claims (e.g., documentation accuracy, test coverage).

• Enforcing reversibility and extensibility in release artifacts.

Part of the Gitbot Fleet, it integrates with repo-care for package manager interface support.

1.1. Key Features

• Placeholder Removal: Auto-detects/removes or flags placeholders.

• License Validation: Ensures compliance with AGPL-3.0-or-later, MIT, or Palimpsest v0.4.

• Claim Verification: Cross-checks docs, tests, and metadata.

• Automated Fixes: Applies corrections via CI/CD.

• Integration: Works with glambot (presentation) and rhodibot (structural compliance).

---

          ┌──────────────────────────────────────────┐
          │                                      │
          │  ┌─────────┐     ┌─────────┐     ┌─────────┐  │
          │  │ rhodibot│     │ echidna │     │  oikos  │  │
          │  │ (RSR    │     │ (verify)│     │ (eco/   │  │
          │  │  struct)│     │         │     │  econ)  │  │
          │  └────┬────┘     └────┬────┘     └────┬────┘  │
          │       │              │              │       │
          │       ▼              ▼              ▼       │
          │  ┌─────────────────────────────────────┐   │
          │  │        SHARED CONTEXT LAYER         │   │
          │  └─────────────────────────────────────┘   │
          │       │              │              │       │
          │       ▼              ▼              ▼       │
          │  ┌─────────┐     ┌─────────┐     ┌─────────┐  │
          │  │ glambot │     │ seambot │     │finishing│  │
          │  │(present-│     │(integr- │     │ -bot    │  │
          │  │ ation)  │     │ ation)  │     │(release)│  │
          │  └─────────┘     └─────────┘     └─────────┘  │
          │                                      │
          └──────────────────────────────────────────┘

2. Use Cases

• Pre-Release Audits: Validates repos before tagging/releases.

• CI/CD Integration: Blocks releases with unresolved issues.

• Educational Use: Helps students/teachers ensure project completeness.

• Reversibility: Logs all changes for rollback/review.

3. Installation

For GitLab CI/CD or local use:

git submodule add https://gitlab.com/hyperpolymath/finishing-bot.git .finishing-bot

3.1. Configuration

Add .finishing-bot/config.yml:

licenses:
  allowed: [AGPL-3.0-or-later, MIT, Palimpsest-v0.4]
  strict: true
placeholders:
  patterns: [TODO, FIXME, XXX]
  action: remove  # or "flag"
claims:
  verify_docs: true
  verify_tests: true

3.2. Automation with Just

Include in your justfile:

finishing-audit:
  @cd .finishing-bot && just audit

finishing-fix:
  @cd .finishing-bot && just fix

4. Usage

Run manually or in CI/CD:

# Audit repository
just finishing-audit

# Apply fixes
just finishing-fix

5. Configuration

Customize via .finishing-bot/config.yml. See Configuration Guide.

6. Documentation

• Project Roadmap

• Configuration Guide

• API Reference

• Licenses

7. Integration with repo-care

• Validates Rhodium Standard Repositories (RSR) compliance.

• Ensures SHA256/SHA-512 integrity for release artifacts.

• Logs actions to the knowledge graph for traceability.

8. License

• AGPL-3.0-or-later

• MIT

• Palimpsest v0.4

9. Community

• Code of Conduct

• Governance

• Funding

10. Relationship to Gitbot Fleet

finishing-bot is part of the Gitbot Fleet. Combine with: - rhodibot (structural compliance) - glambot (presentation quality) - echidnabot (mathematical verification) - oikos (ecological standards) - seambot (integration health)

11. Security

Report vulnerabilities via: - GitLab Issues (private) or - Email: security@hyperpolymath.org (PGP encrypted). See Security Policy.