From zero to green checks in minutes. Copy a proven workflow, see what matters, and customize safely with our visual editor in OctoLab.
✨ Why this repository? | 🚀 Quick start | 📚 Templates | 🤝 Contributing | 📄 License
-
Battle-tested defaults: Templates are safe and fast right out of the box. No guesswork, just production-ready YAML you can trust across all common stacks.
-
Fast to adopt: Every template comes with a concise README, a copy-paste snippet, prerequisites, and quick troubleshooting. You can drop it into
.github/workflows/
in minutes and understand exactly what each step does. -
Visual editing: When you need to make adjustments, click Open in OctoLab to visually tweak the various elements of the workflow. Export clean YAML without having to edit it manually, keeping best practices intact.
-
Choose a template from the gallery that matches your use case (e.g., PR verify, npm publish, Docker build, ...). Open its README to check prerequisites and required secrets/vars.
-
Add the workflow to your repo. Copy
workflow.yml
into.github/workflows/<name>.yml
. -
Confirm the trigger fits your project. Adjust the
on:
block if needed (events, branches, or paths). For example:
on:
pull_request:
types: [opened, synchronize, ready_for_review]
branches: [main, develop]
paths: ["src/**", ".github/workflows/**"]
- Set secrets and repository variables if the template needs them in GitHub:
- Go to Settings → Secrets and variables → Actions
- Add required items (e.g.,
NPM_TOKEN
,GHCR_PAT
,AWS_ACCESS_KEY_ID
, ...) - For constants, prefer repository variables (
vars.*
) over hardcoding.
- Commit it so it runs on the next matching event:
git add .github/workflows/<name>.yml
git commit -m "ci: add <name> workflow"
git push
-
Run and verify. Open a Pull Request or push the relevant tag/branch to trigger the workflow. Check Actions tab for green checks, logs, and timing.
-
(Optional) Customize visually in OctoLab. Tweak runners, jobs and steps, environment variables, etc, without hand-editing YAML. Export and replace your file.
💡 Tip: Keep
permissions:
minimal and only elevate for specific steps.
Verify and ensure the quality of pull requests in a Node.js codebase.
View template | Open in OctoLab
Verify and ensure the quality of pull requests in a monorepo managed with NX.
View template | Open in OctoLab
Publish and release packages to NPM automatically after merging.
View template | Open in OctoLab
Pull Requests welcome! See CONTRIBUTING for style, linting and QA expectations. Be excellent with each other — follow our Code of Conduct.
We operate under the MIT License.
Built with ❤️ by OctoLab