GitHub Workflows

Overview

Create and maintain GitHub Actions workflow YAML files in .github/workflows/. Includes starter templates for common workflow types and reference documentation for syntax, actions, and best practices.

Workflow

1. Determine workflow type -- Identify which type(s) the user needs (CI, deploy, release, PR automation, scheduled, Docker).
2. Start from template -- Copy the matching template from assets/ to .github/workflows/ as a starting point.
3. Customize for the project -- Adapt the template to the project's language, framework, and requirements. Detect the project's ecosystem by examining files like package.json, go.mod, Cargo.toml, pyproject.toml, Makefile, Dockerfile, etc.
4. Apply best practices -- Consult references/best-practices.md to harden security, optimize performance, and improve reliability.
5. Validate -- Check for common syntax issues (see Validation section below).

Templates

Start from these templates in assets/: