https://github.com/raulanatol/template-action-nodejs-ts
📓 A simple docker container action template (using typescript)
https://github.com/raulanatol/template-action-nodejs-ts
actions github-actions template typescript
Last synced: about 1 year ago
JSON representation
📓 A simple docker container action template (using typescript)
- Host: GitHub
- URL: https://github.com/raulanatol/template-action-nodejs-ts
- Owner: raulanatol
- License: mit
- Created: 2020-09-14T13:17:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-12T17:19:43.000Z (over 5 years ago)
- Last Synced: 2025-03-24T12:21:37.148Z (about 1 year ago)
- Topics: actions, github-actions, template, typescript
- Language: Shell
- Homepage:
- Size: 260 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
template-action-nodejs-ts
📓 A simple nodejs action template (using typescript)
---
## Table of Contents
- [Inputs](#inputs)
- [`who-to-greet`](#who-to-greet)
- [Outputs](#outputs)
- [`time`](#time)
- [Example usage](#example-usage)
- [Example using a public action](#example-using-a-public-action)
- [Example using a private action](#example-using-a-private-action)
- [Development](#development)
- [Close release](#close-release)
- [Documentation](#documentation)
## Inputs
### `who-to-greet`
**Required** The name of the person to greet. Default `"World"`.
## Outputs
### `time`
The time we greeted you.
## Example usage
```yaml
uses: raulanatol/template-action-nodejs-ts@v1.0.0
with:
who-to-greet: 'Mona the Octocat'
```
## Example using a public action
**.github/workflows/main.yml**
```yaml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: A job to say hello
steps:
- name: Hello world action step
id: hello
uses: raulanatol/template-action-nodejs-ts@v1.0.0
with:
who-to-greet: 'Mona the Octocat'
# Use the output from the `hello` step
- name: Get the output time
run: echo "The time was ${{ steps.hello.outputs.time }}"
```
## Example using a private action
**.github/workflows/main.yml**
```yaml
on: [push]
jobs:
hello_world_job:
runs-on: ubuntu-latest
name: A job to say hello
steps:
# To use this repository's private action,
# you must check out the repository
- name: Checkout
uses: actions/checkout@v2
- name: Hello world action step
uses: ./ # Uses an action in the root directory
id: hello
with:
who-to-greet: 'Mona the Octocat'
# Use the output from the `hello` step
- name: Get the output time
run: echo "The time was ${{ steps.hello.outputs.time }}"
```
## Development
### Close release
To close a release you only need to execute the makefile with `release_{major|minor|patch}`
Example:
```shell script
make release_minor
```
### Documentation
To generate the documentation you only need to execute the makefile with `docs`.
> Using [doctoc](https://github.com/thlorenz/doctoc)
```shell script
make docs
```