@tufan/action-starter

A simple, full-functionality starter package for building github-actions, built in TypeScript.

The goal is to be simple, lean and automated.

• minimize dependencies.
• use simpler-to-understand dependencies when necessary.
• enable a move-fast mindset.

Support for the following is baked in:

• tslint
• build automation
• ava test-automation
• test coverage (remapped to TypeScript)
• checks dependencies for known vulnerabilities before commit.
• CI integration - using github actions
• Code of Conduct
• commitizen integration

Usage

npx degit tufan-io/action-starter my-github-action
cd my-github-action
npm install

or

npm install degit -g
degit tufan-io/action-starter my-github-action
cd my-github-action
npm install

Answer a few questions to customize the repo, and you're off to the races.

At this point, explore ./src for the bare bones example. Typically, you'd want to modify ./src/index.ts to get started.

Development Tooling

• Development tooling
• Changelog

License

Apache-2.0

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Support

Bugs, PRs, comments, suggestions welcomed!