README.md

SEA-EYE 👀

No frils collection of common actions and pre-made workflows for TypeScript project that uses yarn@v1 as package manager.

Workflows

• Build - run build, lint and test

Actions

• Yarn Cache - cache installed deps

- uses: vtno/seaeye/.github/actions/[email protected]
  with:
    node-version: "16" # override the default version here
    working-dir: "." # override working dir to run the command here

• Yarn Install - install deps and cache using Yarn Cache action

- uses: vtno/seaeye/.github/actions/[email protected]
  with:
    node-version: "16" # override the default version here
    working-dir: "." # override working dir to run the command here

• Yarn Build - build with cached deps

- uses: vtno/seaeye/.github/actions/[email protected]
  with:
    node-version: "16" # override the default version here
    working-dir: "." # override working dir to run the command here

• Yarn Test - test with cached deps

- uses: vtno/seaeye/.github/actions/[email protected]
  with:
    node-version: "16" # override the default version here
    working-dir: "." # override working dir to run the command here

• Yarn Lint - lint with cached deps

- uses: vtno/seaeye/.github/actions/[email protected]
  with:
    node-version: "16" # override the default version here
    working-dir: "." # override working dir to run the command here

• Kumose Deployment - trigger for Kumose deployment

- uses: vtno/seaeye/.github/actions/[email protected]
  with:
    basic_auth_token: "" # Provide the basic auth token here
    kumose_app_id: "" # Provide the Kumose app ID here
    version: "latest" # Specify the version here

Examples

1. Using the build workflow - workflow_test.yml

jobs:
  call-build-workflow:
    uses: vtno/seaeye/.github/workflows/[email protected]
    with:
      working-dir: example

2. Using Yarn Test action - build.yml