Documentation
README
Release Guide โ Ops Update Guide Generator
When to use
- Preparing to release a new version
- Need to document what changed between refs
- Creating operational update guide
- Communicating version updates to Ops team
Skip when
- No git repository available
- Single file change (too small for formal guide)
- Customer-facing release notes only (use simpler template)
Inputs
BASE_REF(string, required): e.g.main,v1.0.0TARGET_REF(string, required): e.g.HEAD,v1.1.0VERSION(string, optional): auto-detected from tags if not providedLANGUAGE(enum, optional, defaulten):en,pt-br,bothMODE(enum, optional, defaultSTRICT_NO_TOUCH):STRICT_NO_TOUCH,TEMP_CLONE_FOR_FRESH_REFS
This is the opening of the README. Read the full README on GitHub.