Action Starter

A minimalistic GitHub repository template to kickstart your GitHub Action project.

Key Features

• Includes a sample metadata file for a GitHub action.
• Develops logic for the GitHub action in Node.js using the following stacks:
  • Yarn for project management.
  • TypeScript for type checking.
  • Jest for unit testing.
  • ESLint for static analysis.
  • Prettier for code formatting.
• Provides a sample workflow file for testing the action.
• Supports dependency updates with Dependabot.

Usage

For detailed instructions on how to use this template, please refer to the wiki.

• Create a new repository from this template.
• Make the following changes to the new repository:
  • Replace the LICENSE file.
  • Update the content of the README file.
  • Define the action information in the action.yml file.
  • Develop the action logic in the src/index.ts file. Use these commands for development:
    • yarn install: Initialize project dependencies.
    • yarn format: Format the source code.
    • yarn lint: Lint the source code.
    • yarn test: Run unit tests. Write the unit tests in files with *.test.ts pattern.
    • yarn build: Build the source code into a single file for distribution.
  • Write tests for the action in the test workflow file.
• Finalize the action and cut the first release.