Skip to content

Create a GitHub Repository Template for GRMP Implementation Repos #15

Open

Description

@cedricdcc

Overview

Currently, setting up a new GRMP implementation repository to house and run configuration tests requires manual configuration, boilerplate copying, and initial workflow setup.

To lower the barrier to entry and ensure consistency across projects, we should create a GitHub Repository Template (grmp-repo-template or similar) with all standard files, configurations, and workflows pre-configured. When users create a new repository on GitHub, they can use this template to instantly provision a ready-to-go GRMP testing repo.


Proposed Contents of the Template

The template repository should include:

  1. Directory Structure: Standardized folders for configuration files, test suites, and schemas.
  2. CI/CD Workflows: Pre-configured GitHub Actions workflows (including the config test orchestration workflow) pointing to the latest standards.
  3. Boilerplate Documentation: A comprehensive README.md explaining how to structure tests, write configurations, and trigger the workflows.
  4. Configuration Files: Standard linter configs (ruff.toml, .pre-commit-config.yaml, etc.) to enforce quality out-of-the-box.

Implementation Steps

  1. Create a new public repository (e.g., vliz-be-opsci/grmp-template or equivalent organization repo).
  2. Mark the repository as a Template repository in GitHub settings (Settings -> Check Template repository).
  3. Populate it with the clean baseline structure derived from grmp-demo.
  4. Document the template creation process in the main documentation/wiki so contributors know how to spin up new repos.

Benefits

  • Faster Onboarding: Developers can spin up a new GRMP test repo in seconds via the green "Use this template" button on GitHub.
  • Standardization: Ensures all new repositories follow the exact same structural and CI/CD conventions.
  • Reduced Maintenance: Updates to core workflows or templates can be managed centrally or templated more cleanly.

Checklist

  • Initialize the baseline repository structure.
  • Add standard workflows, scripts, and documentation files.
  • Enable the "Template repository" option in GitHub settings.
  • Test the template by creating a test repository from it and running a workflow.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions