README.md

@aiou/actions-template

a fork version of typescript-action, self use

Edit on StackBlitz ⚡️

Use this template to bootstrap the creation of a Typescript action.:rocket:

This template includes tests, linting, a validation workflow, publishing, and versioning guidance.

features

• 💪 Typescript - type safe
• 🦋 Changeset - modern changelog/version tool
• 📦 pnpm - much faster than yarn and npm

development

Setup environment(if actions rely on environment)

1. copy .env.sample file to .env
2. replace with real environment

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

const core = require('@actions/core');
...

async function run() {
  try {
      ...
  }
  catch (error) {
    core.setFailed(error.message);
  }
}

run()

See the toolkit documentation for the various packages.

change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the documentation

publish

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run build

pnpm run build

Since the packaged index.js is run from the dist folder.

git add dist

release

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

git checkout -b v1
git commit -a -m "v1 release"

git push origin v1

Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! 🚀

See the versioning documentation

usage

You can now consume the action by referencing the v1 branch

uses: <namespace>/<repo>@v1
with:
  milliseconds: 1000

See the actions tab for runs of this action! 🚀

built with ❤️ by 😼