template-action-nodejs-ts

📓 A simple nodejs action template (using typescript)

---

Table of Contents

• Inputs
  • who-to-greet
• Outputs
  • time
• Example usage
• Example using a public action
• Example using a private action
• Development
  • Close release
  • Documentation

Inputs

who-to-greet

Required The name of the person to greet. Default "World".

Outputs

time

The time we greeted you.

Example usage

uses: raulanatol/[email protected]
with:
  who-to-greet: 'Mona the Octocat'

Example using a public action

.github/workflows/main.yml

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/[email protected]
      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

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:

make release_minor

Documentation

To generate the documentation you only need to execute the makefile with docs.

Using doctoc

make docs