https://github.com/hywax/github-action-template

A completely ready-made template for creating a Github Action
https://github.com/hywax/github-action-template

github-actions starter-template template typescript vite vitest

Last synced: about 2 months ago
JSON representation

A completely ready-made template for creating a Github Action

• Host: GitHub
• URL: https://github.com/hywax/github-action-template
• Owner: hywax
• License: mit
• Created: 2024-02-06T14:14:25.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-11-14T19:04:19.000Z (about 2 months ago)
• Last Synced: 2024-11-14T20:18:40.650Z (about 2 months ago)
• Topics: github-actions, starter-template, template, typescript, vite, vitest
• Language: TypeScript
• Homepage:
• Size: 1.1 MB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• fucking-awesome-vite - github-action-template - Starter template for GitHub Actions, Typescript, ESLint, Vitest, Husky, Conventional Commits. (Get Started / Tauri)
• jimsghstars - hywax/github-action-template - A completely ready-made template for creating a Github Action (TypeScript)
• awesome-vite - github-action-template - Starter template for GitHub Actions, Typescript, ESLint, Vitest, Husky, Conventional Commits. (Get Started / Tauri)

README

        
# Github Action Template

Use this template to bootstrap the creation of a TypeScript action.

## Features

* 🪄️ All of the code is written in TypeScript

* ✨ Fully customized [eslint](https://eslint.org/) configuration based on the config by [Antfu](https://github.com/antfu/eslint-config)

* 🧪 Write tests quickly and conveniently with [vitest](https://vitest.dev/)

* 🤝 Supports [conventional commits](https://www.conventionalcommits.org/)

* 💅 Generate beautiful changelogs with [changelogen](https://github.com/unjs/changelogen)

* ♾️ GitHub CI for your build

* 📢 Issue templates

* 📝 Pull request template

* 🤖 Ready configuration for [renovatebot](https://github.com/apps/renovate) with [renovate-config](https://github.com/hywax/renovate-config)

* 🚀 Action releases with just one command

## Get started

### GitHub Template

This is a template repo. Click the green [Use this template](https://github.com/hywax/github-action-template/generate) button to get started.

### Git Clone

```shell

git clone https://github.com/hywax/github-action-template.git

cd github-action-template

pnpm install

```

## Usage

The template contains the following scripts:

* `build` - Build for production

* `release` - Generate changelog and npm publish

* `lint` - Checks your code for any linting errors

* `test` - Run all tests

* `test:watch` - Run all tests with watch mode

* `test:coverage` - Run all tests with code coverage report

* `typecheck` - Run TypeScript type checking

* `prepare` - Script for setting up husky hooks

## Used by

If you are using this template, feel free to open a PR to add your project to the list.

## License

This template was created under the [MIT License](LICENSE).