github-actions-template

Template Usage

This repo is meant to help kickstart custom, reusable Actions. By sourcing repos from this template developers are encouraged to follow certain standards:

• Linting job(s) for checking project files for syntax/formatting errors
• Testing job(s) for verifying new changes don't break functionality
• A Release workflow for creating automated, versioned releases of Actions
• Usage documentation clearly visible via the README.md

Developer TODOs

• Populate the sections of this README.md with information specific to your new Action.

Other Action Types

If you'd like to create Docker or JavaScript actions, checkout these official templates from GitHub:

• Docker Action
• JavaScript Action

Please remove this section after creating your new repo with your template and completing the Developer TODOs section!

Prints a simple message to the console. It's primary purpose is to serve as an example for how to create and release a custom Composite GitHub Action.

Usage

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Custom Action
        uses: your-org-name/action-template@v1

Input	Description	Required	Default
target	Value to use when printing 'hello ' message	false	world

Output	Description
N/A	N/A

Contributing

This project uses semantic-release and conventional commits to help automate the release process. In order to track changes use the following commit formats to track changes according to semantic versioning standards.

Commit message	Release type
fix: stop graphite breaking when too much pressure applied	(Patch) Fix Release
feat: add 'graphiteWidth' option	(Minor) Feature Release
perf: remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons.	(Major) Breaking Release (Note that the BREAKING CHANGE: token must be in the footer of the commit) Where commit message format is : [type]: [subject] [BLANK LINE] [body] <-- not required [BLANK LINE] [footer]

Once changes are merged via Pull Request or direct commit to main, the release workflow will analyze commits, calculate the next version, and publish a new Release to GitHub.

Git Hooks

In order to prevent commits with breaking code, the hooks/ directory has been included to run pre-commit checks against your local code. This will run:

• yamllint
• markdownlint
• actionlint

To configure your local repository to use these Git Hooks run git config core.hooksPath hooks/.