https://github.com/vtno/seaeye
SEA-EYE is a collection of useful Github actions and workflows used to build CI pipelines for TypeScript applications
https://github.com/vtno/seaeye
github github-actions
Last synced: about 1 month ago
JSON representation
SEA-EYE is a collection of useful Github actions and workflows used to build CI pipelines for TypeScript applications
- Host: GitHub
- URL: https://github.com/vtno/seaeye
- Owner: vtno
- Created: 2022-05-25T18:05:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T09:40:26.000Z (almost 2 years ago)
- Last Synced: 2024-05-21T10:09:08.033Z (almost 2 years ago)
- Topics: github, github-actions
- Language: JavaScript
- Homepage:
- Size: 92.8 KB
- Stars: 12
- Watchers: 1
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
```yaml
- uses: vtno/seaeye/.github/actions/yarn-build@v0.1.0
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
```yaml
- uses: vtno/seaeye/.github/actions/yarn-install@v0.1.0
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
```yaml
- uses: vtno/seaeye/.github/actions/yarn-build@v0.1.0
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
```yaml
- uses: vtno/seaeye/.github/actions/yarn-test@v0.1.0
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
```yaml
- uses: vtno/seaeye/.github/actions/yarn-lint@v0.1.0
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
```yaml
- uses: vtno/seaeye/.github/actions/kumose-deployment@v0.4.1
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](https://github.com/vtno/seei/blob/v0.1.0/.github/workflows/workflow_test.yml)
```yaml
jobs:
call-build-workflow:
uses: vtno/seaeye/.github/workflows/build.yml@v0.1.0
with:
working-dir: example
```
2. Using `Yarn Test` action - [build.yml](https://github.com/vtno/seei/blob/v0.1.0/.github/workflows/build.yml#L46-L48)