gha-example

The action

This repository contains a Node.js-based GitHub Actions' template, with:

• CI action files - .github/workflows
• issues (bug report / feature request) - .github/ISSUE_TEMPLATE
• pull request description - .github/pull_request_template
• src - template source with input/output manipulation
• test - tests
• lint/format elements:
  • .markdownlint.yml
  • .prettierrc
  • .yamllint.yml
  • eslint.config.js

It also contains project-support files as mentioned in section The project, in this README.

To use it simply clone the project and search for references:

• paulo.ferraz.oliveira (and @gmail.com, and or Paulo)
• gha-example

and tweak those to your liking.

Note: for more JavaScript action -related information be sure to check out GitHub's documentation on Creating a JavaScript action.

Usage

See action.yml for the action's specification.

Check out GitHub's documentation to learn more about this file and its format.

The project

Changelog

A complete changelog can be found under GitHub releases.

Code of Conduct

This project's code of conduct is made explicit in CODE_OF_CONDUCT.md.

Contributing

First of all, thank you for contributing with your time and patience.

If you want to request a new feature make sure to open an issue so we can discuss it first.

Bug reports and questions are also welcome, but do check you're using the latest version of the action - if you found a bug - and/or search the issue database - if you have a question, since it might have already been answered before.

Contributions will be subject to the MIT License. You will retain the copyright.

For more information check out CONTRIBUTING.md.

License

License information can be found inside LICENSE.

Security

This project's security policy is made explicit in SECURITY.md.