/template

The template repository for actions.

Primary LanguageTypeScriptMIT LicenseMIT

Action Template

Build Status Dependency Status

This is a template for GitHub Actions with TypeScript.

Usage

  1. Click "Use this template" button on GitHub (https://github.com/mysticatea-actions/template).
  2. Input the information of your new reporsitory then click "Create repository from template" button.
  3. Update package.json file with the correct fields of name, description, repository, author, bugs, and homepage.
  4. Update LICENSE file with your license.
  5. Update README.md file.
  6. Start to develop.

File Structure

<root>
├ dist    ... Built result.
├ lib     ... Source code.
├ scripts ... Development tools.
└ test    ... Test code.

Development Tools

  • npm test ... Run tests.
  • npm version <how> ... Bump a version and release it. The <how> is one of patch, minor, major, and etc. See https://docs.npmjs.com/cli/version for details. This will do the following steps:
    1. Check the code with ESLint and TypeScript compiler.
    2. Run tests.
    3. Bump version.
    4. Build the code.
    5. Release it with scripts/release.ts script.
  • npm run build ... Build code then create dist directory.