https://github.com/eficode/github-action-template
This is a template repository for creating new Github Actions
https://github.com/eficode/github-action-template
actions eficode github template
Last synced: 2 months ago
JSON representation
This is a template repository for creating new Github Actions
- Host: GitHub
- URL: https://github.com/eficode/github-action-template
- Owner: eficode
- Created: 2021-11-25T13:12:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-25T16:54:31.000Z (over 4 years ago)
- Last Synced: 2025-05-16T17:44:34.067Z (about 1 year ago)
- Topics: actions, eficode, github, template
- Language: TypeScript
- Homepage: https://eficode.com
- Size: 123 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Github Action Template
This is a template repository for creating new Github Actions.
## Prerequisites
None
## Running
Add action `eficode/github-action-template@latest` to your actions. The outputs of the action (if any) can be used in the following actions with `${{ steps..outputs.output_example }}`.
```
name: Using the Github Action Template
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: eficode/github-action-template@latest
id: output_id
with:
input_example: "input"
- name: update status
run: |
echo "output_example: ${{ steps.output_id.outputs.output_example }}"
```
## Building
```bash
npm run build
```
## Releasing
Release writes [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to `CHANGELOG.md`, creates a new tag for the next version and pushes the changes. Actions in `release.yml` will then create a new release in Github.
```bash
npm run release
```
## Testing
You can run the tests with:
```bash
npm test
```
And lint with:
```bash
npm run lint
```