Skip to content

Create copilot-setup-steps.yml workflow for automated project setup #78

Description

@unclesp1d3r

Feature Request

Description

Create a GitHub Copilot setup workflow file (.github/workflows/copilot-setup-steps.yml) that automates the initial project setup and environment configuration for new contributors and AI agents working on the opnDossier project.

Problem Statement

Currently, new contributors and AI agents need to manually follow setup steps from documentation, which can lead to:

  • Inconsistent development environments
  • Missing dependencies or incorrect versions
  • Time-consuming manual setup process
  • Potential errors in configuration
  • Lack of standardized onboarding process

Proposed Solution

Create a comprehensive GitHub Actions workflow that:

  1. Environment Setup

    • Install required Go version (1.21.6+)
    • Install just task runner
    • Install development tools (golangci-lint, goimports, etc.)
    • Set up proper Go module environment
  2. Dependency Management

    • Run go mod download to fetch dependencies
    • Run go mod tidy to clean up dependencies
    • Validate go.sum integrity
  3. Code Quality Setup

    • Install and configure golangci-lint
    • Set up pre-commit hooks for code formatting
    • Configure markdown linting tools
    • Set up test coverage reporting
  4. Project Validation

    • Run just ci-check to validate complete setup
    • Verify all tests pass
    • Check code formatting compliance
    • Validate documentation structure
  5. Documentation Generation

    • Generate API documentation
    • Update project documentation
    • Validate markdown formatting

Additional Context

Requirements Alignment:

  • Supports F001 (Multi-format export capability)
  • Supports F002 (Validation system)
  • Supports F003 (Audit engine)
  • Supports F004 (CLI interface)

Technical Requirements:

  • Must work with existing .github/workflows/ structure
  • Should integrate with existing CI/CD pipeline
  • Must follow project's Go development standards
  • Should support both manual and automated triggers

Integration Points:

  • Works with existing justfile commands
  • Compatible with current GitHub Actions workflows
  • Follows project's development workflow guidelines
  • Integrates with existing copilot instructions

Expected Benefits:

  • Reduced onboarding time for new contributors
  • Consistent development environments
  • Automated quality checks during setup
  • Better integration with AI agent workflows
  • Improved project maintainability

Success Criteria

  • Workflow successfully sets up development environment
  • All project quality checks pass automatically
  • New contributors can use workflow for onboarding
  • AI agents can reference workflow for setup validation
  • Integration with existing CI/CD pipeline
  • Documentation updated to reference new workflow
  • Workflow follows project's development standards

This workflow will complement the existing CI/CD pipeline and provide a standardized setup process for the project.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions