https://github.com/paulo-ferraz-oliveira/gha-example

A GitHub Action example repo.
https://github.com/paulo-ferraz-oliveira/gha-example

Last synced: about 1 month ago
JSON representation

A GitHub Action example repo.

• Host: GitHub
• URL: https://github.com/paulo-ferraz-oliveira/gha-example
• Owner: paulo-ferraz-oliveira
• License: mit
• Created: 2024-06-17T17:53:47.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-17T22:04:20.000Z (about 2 months ago)
• Last Synced: 2024-09-18T02:51:34.455Z (about 2 months ago)
• Language: JavaScript
• Size: 126 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# `gha-example` [![Action][ci-img]][ci]

[ci]: https://github.com/paulo-ferraz-oliveira/gha-example/actions/workflows/ci.yml

[ci-img]: https://github.com/paulo-ferraz-oliveira/gha-example/actions/workflows/ci.yml/badge.svg

## 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](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action).

### Usage

See [action.yml](action.yml) for the action's specification.

Check out [GitHub's documentation](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions)

to learn more about this file and its format.

## The project

### Changelog

A complete changelog can be found under [GitHub releases](https://github.com/paulo-ferraz-oliveira/gha-example/releases).

### Code of Conduct

This project's code of conduct is made explicit in [CODE_OF_CONDUCT.md](https://github.com/paulo-ferraz-oliveira/gha-example/blob/main/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](https://github.com/paulo-ferraz-oliveira/gha-example/issues) 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](https://github.com/paulo-ferraz-oliveira/gha-example/blob/main/CONTRIBUTING.md).

### License

License information can be found inside [LICENSE](https://github.com/paulo-ferraz-oliveira/gha-example/blob/main/LICENSE.md).

### Security

This project's security policy is made explicit in [SECURITY.md](https://github.com/paulo-ferraz-oliveira/gha-example/blob/main/SECURITY.md).