opencommit/roadmap

The Starter Kit (workflow blueprints) #10

New issue

Open

opened 2026-04-11 23:16:01 +02:00 by mvdkleijn · 0 comments

mvdkleijn commented

2026-04-11 23:16:01 +02:00

Owner

1. What

The creation of a curated collection of "Workflow Blueprints". Pre-configured .forgejo/workflows templates for Python, JavaScript, Rust, and Go. These are not mandatory standards, but rather high-quality, ready-to-use templates provided as a service to help open-source maintainers accelerate their CI/CD setup using proven, efficient patterns.

2. Why

To provide value to our community by reducing the "configuration tax" of managing CI/CD pipelines. Many open-source maintainers want to focus on code rather than YAML maintenance. By providing these blueprints, we offer a way for projects to adopt industry-standard testing and building patterns with minimal effort, while simultaneously helping them optimize resource usage on our infrastructure through efficient, well-tuned workflow steps.

Note: We do not dictate project management; we provide the tools to make efficient management easier.

3. Boundaries

In-Scope:
- Developing "Blueprint" templates for Python, JS, Rust, and Go that focus on reliability and efficiency.
- Providing a library of modular components (e.g., reusable actions for caching or artifact uploading).
- Creating documentation that treats these workflows as optional starting points that can be heavily customized.
- Ensuring all templates are optimized to minimize runner resource consumption.
Out-of-Scope:
- Enforcing these workflows as a requirement for hosting on our instance.
- Overriding or interfering with custom user-defined .forgejo/workflows.
- Providing support for complex, bespoke deployment logic that falls outside the scope of the initial "Blueprints."

4. Definition of Done

Blueprint Availability: Functional, well-documented templates for Python, JS, Rust, and Go are available in a public, easily accessible location (e.g., a template repository).
Service Verification: Each blueprint is verified to run successfully on the instance's runners and demonstrates an efficient use of caching/resources.
Hello World Verification: Apart from the above Service Verification, where possible, we run verification pipelines using "hello world" apps and the blueprints. These pipelines are used to verify changes to blueprints do not break the blueprints.
Autonomy Preservation: Documentation clearly communicates that these templates are optional and provides clear guidance on how users can extend or deviate from them.
Discoverability: The blueprints are easy to find for new users looking to bootstrap a project without manual configuration.

## 1. What The creation of a curated collection of "Workflow Blueprints". Pre-configured `.forgejo/workflows` templates for Python, JavaScript, Rust, and Go. These are not mandatory standards, but rather high-quality, ready-to-use templates provided as a service to help open-source maintainers accelerate their CI/CD setup using proven, efficient patterns. ## 2. Why To provide value to our community by reducing the "configuration tax" of managing CI/CD pipelines. Many open-source maintainers want to focus on code rather than YAML maintenance. By providing these blueprints, we offer a way for projects to adopt industry-standard testing and building patterns with minimal effort, while simultaneously helping them optimize resource usage on our infrastructure through efficient, well-tuned workflow steps. _**Note:** We do not dictate project management; we provide the tools to make efficient management easier._ ## 3. Boundaries * **In-Scope:** * Developing "Blueprint" templates for Python, JS, Rust, and Go that focus on reliability and efficiency. * Providing a library of modular components (e.g., reusable actions for caching or artifact uploading). * Creating documentation that treats these workflows as *optional* starting points that can be heavily customized. * Ensuring all templates are optimized to minimize runner resource consumption. * **Out-of-Scope:** * Enforcing these workflows as a requirement for hosting on our instance. * Overriding or interfering with custom user-defined `.forgejo/workflows`. * Providing support for complex, bespoke deployment logic that falls outside the scope of the initial "Blueprints." ## 4. Definition of Done * [ ] **Blueprint Availability:** Functional, well-documented templates for Python, JS, Rust, and Go are available in a public, easily accessible location (e.g., a template repository). * [ ] **Service Verification:** Each blueprint is verified to run successfully on the instance's runners and demonstrates an efficient use of caching/resources. * [ ] **Hello World Verification:** Apart from the above Service Verification, where possible, we run verification pipelines using "hello world" apps and the blueprints. These pipelines are used to verify changes to blueprints do not break the blueprints. * [ ] **Autonomy Preservation:** Documentation clearly communicates that these templates are *optional* and provides clear guidance on how users can extend or deviate from them. * [ ] **Discoverability:** The blueprints are easy to find for new users looking to bootstrap a project without manual configuration.