https://github.com/threeal/composite-action-starter

A minimalistic GitHub repository template to kickstart your GitHub composite action project
https://github.com/threeal/composite-action-starter

actions boilerplate composite-action github github-actions github-composite-action template

Last synced: about 1 month ago
JSON representation

A minimalistic GitHub repository template to kickstart your GitHub composite action project

• Host: GitHub
• URL: https://github.com/threeal/composite-action-starter
• Owner: threeal
• License: unlicense
• Created: 2023-09-05T09:18:13.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-10T14:10:32.000Z (2 months ago)
• Last Synced: 2024-09-10T15:50:30.713Z (2 months ago)
• Topics: actions, boilerplate, composite-action, github, github-actions, github-composite-action, template
• Homepage:
• Size: 39.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Composite Action Starter

A minimalistic [GitHub repository template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) to kickstart your [GitHub composite action](https://github.com/features/actions) project.

## Key Features

- Includes a sample metadata file for a GitHub composite action.

- Provides a sample workflow file for testing the action.

- Supports dependency updates with [Dependabot](https://docs.github.com/en/code-security/dependabot).

## Usage

> For detailed instructions on how to use this template, please refer to [the wiki](https://github.com/threeal/composite-action-starter/wiki).

- Create a new repository from this template.

- Make the following changes to the new repository:

  - Replace the [LICENSE](LICENSE) file.

  - Update the content of the [README](README.md) file.

  - Define the action information and logic in the [action.yml](action.yml) file.

  - Write tests for the action in the [test workflow](.github/workflows/test.yaml) file.

- Finalize the action and cut the first release.