Skip to content

refactor!: Convert Repository to Copier Template

[refactor] Convert Repository to Copier Template

What?

Convert the entire DevSecOps plugin repository into a Copier template (copier.org), enabling teams to easily generate new instances with customised configurations and workflows.

Why?

Streamline project initialisation and ensure consistency across DevSecOps implementations whilst allowing for customisation of specific elements based on project needs.

How?

Feature: DevSecOps Plugin Repository Templating
  As a DevOps engineer
  I want to convert the repository into a Copier template
  So that teams can quickly generate customised DevSecOps environments

  Context:
    Given a fully functional DevSecOps plugin repository
    And Copier installed in the development environment

  Scenario: Repository Structure Conversion
    Given the current repository structure with Task-based automation
    When I reorganise the repository according to Copier's conventions
    Then the template should maintain all existing functionality
    And include template-specific configuration files

  Scenario: Template Configuration Setup
    Given the need for customisable elements
    When I create the copier.yml configuration
    Then it should include variables for:
      | Variable Category | Examples |
      | Project Metadata  | name, description, version |
      | Tool Selection   | enabled tools, versions |
      | CI/CD Settings   | pipeline configurations |
      | Security Policies| scanning rules, thresholds |

Definition of Done

  • Create copier.yml with template configuration
  • Implement template questions for customisation
  • Reorganise directory structure to match Copier conventions
  • Add template-specific documentation
  • Create template tests for validation
  • Update CI/CD pipeline to test template generation
  • Provide migration guide for existing projects
  • Add template usage documentation
  • Test template generation with different configurations
  • Update all paths and references to be template-aware

Breaking change? ⚠️ Yes - Major structural changes required. Will need:

  1. Migration guide for existing projects
  2. Version bump to reflect breaking changes
  3. Clear documentation of new template-based workflow

Additional Information:

  • Version: 0.2.0
  • Copier Version: ≥ 8.3.0
  • Dependencies:
    • Python ≥ 3.11
    • Poetry for dependency management