Blueprints

Reusable templates and starting points for building and running projects in the OpenCommit ecosystem. Every blueprint here is optional — use it as-is, adapt it freely, or ignore it completely.

All blueprints are published under CC0-1.0 so they can be copied into any project without attribution headaches.

Catalog

Workflow blueprints

blueprints/workflows is a set of workflow blueprints, not a single blueprint. Each workflow ships in two forms: a reusable workflow_call definition for subscribers and a copy-pastable standalone example for projects that want no cross-repository coupling.

Workflow	Reusable (on: workflow_call)	Copy-pastable example	Purpose
hello-ci	.forgejo/workflows/hello-ci.yml	examples/hello-ci.yml	Fast smoke test confirming the runner is available and basic execution works.
reuse	.forgejo/workflows/reuse.yml	examples/reuse.yml	Runs reuse lint to verify REUSE compliance.
go-ci	.forgejo/workflows/go-ci.yml	examples/go-ci.yml	CI for Go projects — build, test, and check on push/PR.

Template blueprints

Template repositories produce fully owned starter projects, CI included.

Blueprint	Repository	Purpose
template-go	blueprints/template-go	OpenCommit template for new Go projects.

How to use

Blueprints can be consumed in three ways, ordered from easiest to most autonomous.

1. New project — start from a repository template

1. In OpenCommit: New Repository → Template.
2. Pick OpenCommit Blueprints → template-go.
3. Tick at least Git content to copy the repository files.
4. On your first push you get a working CI run.

The generated workflow YAML is yours afterwards — you own it and can change it as you like.

2. Existing project — copy an example

Full autonomy, no coupling:

1. Grab the workflow you need from the docs and workflows/examples/, e.g. go-ci.yml.
2. Paste it into your project as .forgejo/workflows/ci.yml.
3. Adjust and commit.

3. Existing project — subscribe by reference

Optional coupling with easy upgrades:

1. Add a five-line caller to your project:

   name: ci
   on: [push, pull_request]
   jobs:
     ci:
       uses: blueprints/workflows/.forgejo/workflows/go-ci.yml@v1
   

2. Upgrade by bumping the pinned tag (e.g. @v1 → @v2). The coupling is strictly optional and documented as such — you can switch to a copy at any time.

Autonomy notice

Everything in this organisation is optional. Blueprints are templates — starting points, not requirements. No project is obligated to use any of them, and using one does not lock you in.

• Optional. Every blueprint is offered as-is for convenience. You can skip any or all of them without consequence.
• Extend. Copy, fork, or modify any blueprint for your own needs. Blueprints are intentionally small and focused so they are easy to build on.
• Deviate. Each blueprint documents the conventions it assumes and the trade-offs it makes. Treat none of them as sacred — change or drop any part that does not fit your project.
• Own your divergence. When you copy a blueprint and deviate, you own the result. There is no requirement to contribute changes back or ask permission.