ci-pipeline-synthesizer
Scannednpx machina-cli add skill ArabelaTso/Skills-4-SE/ci-pipeline-synthesizer --openclawCI Pipeline Synthesizer
Overview
Generate production-ready GitHub Actions workflow files for library and package projects with automated build and test stages, dependency caching, and multi-version testing matrices.
Workflow
1. Identify Project Type
Determine the package ecosystem by examining project files:
- Node.js/npm:
package.jsonpresent - Python:
setup.py,pyproject.toml, orrequirements.txtpresent - Go:
go.modpresent - Rust:
Cargo.tomlpresent
2. Select Template
Use the appropriate template from assets/ based on project type:
github-actions-nodejs.yml- Node.js/npm packagesgithub-actions-python.yml- Python packagesgithub-actions-go.yml- Go modulesgithub-actions-rust.yml- Rust crates
3. Customize Configuration
Adapt the template to project-specific needs:
Test commands: Update test scripts to match project conventions
- Node.js:
npm test,npm run test:coverage - Python:
pytest,python -m unittest - Go:
go test ./... - Rust:
cargo test
Build commands: Adjust build steps if needed
- Node.js:
npm run build(if build step exists) - Python:
python -m build - Go:
go build - Rust:
cargo build --release
Version matrix: Modify tested versions based on support policy
- Node.js: LTS versions (16.x, 18.x, 20.x)
- Python: Active versions (3.9, 3.10, 3.11, 3.12)
- Go: Recent versions (1.21, 1.22)
- Rust: stable, beta (optional)
Trigger conditions: Adjust when pipeline runs
- Default: Push to main/master, all pull requests
- Custom: Specific branches, paths, or schedules
4. Place Workflow File
Create the workflow file at .github/workflows/ci.yml in the project root. If .github/workflows/ doesn't exist, create the directory structure first.
5. Verify Configuration
Check that the generated workflow:
- Uses appropriate actions versions (e.g.,
actions/checkout@v4,actions/setup-node@v4) - Includes dependency caching for faster builds
- Runs on appropriate triggers (push, pull_request)
- Tests against relevant version matrices
- Has clear job and step names
Template Features
All templates include:
- Dependency caching: Speeds up builds by caching package managers
- Matrix testing: Tests across multiple language/runtime versions
- Parallel execution: Runs tests for different versions concurrently
- Clear naming: Descriptive job and step names for easy debugging
- Best practices: Uses recommended actions and configurations
Customization Examples
Add code coverage reporting:
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
file: ./coverage.xml
Add linting step:
- name: Run linter
run: npm run lint # or: pylint, golangci-lint, cargo clippy
Restrict to specific branches:
on:
push:
branches: [main, develop]
pull_request:
branches: [main]
Add scheduled runs:
on:
schedule:
- cron: '0 0 * * 0' # Weekly on Sunday
Tips
- Start with the template and customize incrementally
- Test the workflow by creating a pull request or pushing to a test branch
- Use
actions/cachefor dependencies to reduce build times - Keep matrix versions current with language support policies
- Add status badges to README.md:
Source
git clone https://github.com/ArabelaTso/Skills-4-SE/blob/main/skills/ci-pipeline-synthesizer/SKILL.mdView on GitHub Overview
Generates production-ready GitHub Actions workflows for library and package projects, enabling automated build and test stages with dependency caching and multi version matrices. It detects the project ecosystem (Node.js/npm, Python, Go, or Rust) and applies a tailored template, then adapts test, build, version matrix, and trigger settings for the repository.
How This Skill Works
The tool identifies the project type by inspecting key files (package.json for Node, setup.py or pyproject.toml or requirements.txt for Python, go.mod for Go, or Cargo.toml for Rust) and selects the corresponding template from assets. It customizes test and build commands, adjusts the version matrix, ensures proper triggers, and saves the workflow to .github/workflows/ci.yml with verified action versions and dependency caching.
When to Use It
- When creating a new CI workflow for a Node.js/npm package and you want dependency caching, a matrix of Node versions (16.x, 18.x, 20.x), and test/build steps.
- When updating CI for a Python package (setup.py/pyproject.toml) that should test against active Python versions (3.9–3.12) with pytest-based tests.
- When adding CI to a Go module (go.mod) to run go test ./... with module caching and release-ready artifacts.
- When adding CI to a Rust crate (Cargo.toml) to run cargo test, cargo build --release, and possibly publish artifacts.
- When maintaining a multi-language library or monorepo that needs a single, templated CI strategy with caching, matrix testing, and artifact publishing across ecosystems.
Quick Start
- Step 1: Identify the project ecosystem by checking for package.json, pyproject.toml/setup.py, go.mod, or Cargo.toml.
- Step 2: Pick the matching template from assets and customize test/build commands, version matrix, and triggers.
- Step 3: Save as .github/workflows/ci.yml at the repo root and push to trigger the workflow.
Best Practices
- Enable dependency caching for faster builds using language specific caches.
- Define a matrix for supported versions (Node.js, Python, Go, Rust) and run tests in parallel.
- Use descriptive job and step names for easier debugging.
- Pin actions to stable major versions like actions/checkout@v4 and actions/setup-node@v4.
- Publish build artifacts or coverage reports where appropriate and keep version policies up to date.
Example Use Cases
- Node.js npm package CI example using npm ci, npm test, and npm run build with a matrix across Node 16, 18, and 20.
- Python package CI example running pytest across Python 3.9-3.12 with build using python -m build.
- Go module example running go test ./... and go build with module caching.
- Rust crate example running cargo test and cargo build --release with cargo cache.
- Monorepo with multiple ecosystems sharing a single ci.yml and separate jobs per package.
