You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Create a GitHub Repository Template for GRMP Implementation Repos #15
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:
Directory Structure: Standardized folders for configuration files, test suites, and schemas.
CI/CD Workflows: Pre-configured GitHub Actions workflows (including the config test orchestration workflow) pointing to the latest standards.
Boilerplate Documentation: A comprehensive README.md explaining how to structure tests, write configurations, and trigger the workflows.
Configuration Files: Standard linter configs (ruff.toml, .pre-commit-config.yaml, etc.) to enforce quality out-of-the-box.
Implementation Steps
Create a new public repository (e.g., vliz-be-opsci/grmp-template or equivalent organization repo).
Mark the repository as a Template repository in GitHub settings (Settings -> Check Template repository).
Populate it with the clean baseline structure derived from grmp-demo.
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.
Activity