bluefly/gov_compliance

Government compliance module for security policies and regulatory requirements

0.1.0 2025-07-27 17:47 UTC

README

Repository Information

  • Type: Drupal Module (Git Submodule)
  • GitLab URL: https://gitlab.bluefly.io/llm/gov_compliance
  • Submodule Path: web/modules/custom/gov_compliance
  • Local Path: /Users/flux423/Sites/LLM/llm-platform/web/modules/custom/gov_compliance

Integration Steps

  1. Navigate to Individual Repository

    # This module is a git submodule, work in its individual repo
    cd /path/to/individual/gov_compliance/repository
    
  2. Copy OpenAPI Specification

    cp openapi.yaml ./
    
  3. Create Contract Testing Structure

    mkdir -p tests/src/Functional
    mkdir -p tests/features
    
  4. Add PHPUnit Configuration

    <!-- phpunit.xml -->
    <testsuite name="gov_compliance API Contract Tests">
      <directory>tests/src/Functional</directory>
      <file>tests/src/Functional/*ApiContractTest.php</file>
    </testsuite>
    
  5. Configure JSON:API Entities

    # JSON:API is built into Drupal 10 core, just needs configuration
    drush en rest restui serialization hal -y
    drush cr
    
  6. Update GitLab CI

    include:
      - component: gitlab.bluefly.io/llm/gitlab_components/components/ci-cd/drupal/template@latest
      - component: gitlab.bluefly.io/llm/gitlab_components/components/testing/comprehensive-testing@latest
       
    drupal_api_validation:
      extends: .drupal_base
      script:
        - drush en rest restui serialization hal -y
        - drush cr
        - vendor/bin/phpunit tests/src/Functional/*ApiContractTest.php
    
  7. Commit Changes

    git add .
    git commit -m "feat: implement API-first architecture for Drupal module
       
    - Add OpenAPI 3.1 specification with JSON:API endpoints
    - Implement PHPUnit contract tests
    - Configure REST and JSON:API endpoints
    - Enable API-first development workflow
       
    🤖 Generated with API-First Transformation
       
    Co-Authored-By: Claude <noreply@anthropic.com>"
    git push origin main
    

JSON:API Endpoints

  • Entities: /jsonapi/gov_compliance/gov_compliance
  • Custom API: /api/v1/gov_compliance/*
  • Health Check: /api/v1/gov_compliance/health

Production Deployment

Local Development