{{PROJECT_NAME}} is [add your project description here].
- [List key features of your project]
- bash 3.2+
- mise
Run mise install to install all tools, then mise run install for any additional dependencies.
git clone <your-repo>
cd {{PROJECT_NAME}}
mise installType mise tasks to see all available tasks:
❯ mise tasks
build Build the project
clean Clean build artifacts
install Install dependencies
publish Publish package to registry
run Run project locally
test Run tests
...Build, run, and test with mise run:
mise run run
mise run testTask dependencies run automatically — mise run test runs build first!
Commit using conventional commits (feat:, fix:, docs:). Merge/push to main and CI/CD will run automatically bumping your project version and publishing a package.
- User Guide - Complete setup and usage guide
- Architecture - Design and implementation details
- Infrastructure - Infrastructure and CI/CD details
- mise - dev tool manager
- semantic-release
- bats-core bash testing
- Google Shell Style Guide
- Conventional Commits
- GitHub Actions
- GCP Artifact Registry
Template: {{TEMPLATE_NAME}} v{{TEMPLATE_VERSION}}