README.md

deploy-action

The nucleuscloud/deploy-action is a Typescript action that deploys your service to Nucleus in your GitHub Actions workflow.

Must be used with nucleuscloud/setup-nucleus-cli-action@v1. Service account credentials are required to deploy a service.

Usage

Deploy

Set up a Nucleus service account in order to authenticate against Nucleus CLI.

name: ci

on:
  push:
    branches: main

jobs:
  login:
    runs-on: ubuntu-latest
    steps:
      - name: Download Nucleus CLI & Login
        uses: nucleuscloud/setup-nucleus-cli-action@v1
        with:
          client_id: ${{ secrets.CLIENT_ID }}
          client_secret: ${{ secrets.CLIENT_SECRET }}
      - name: Deploy service to Nucleus
        uses: nucleuscloud/deploy-action@v1
        with:
          environment: nucleus-env

Customizing

inputs

Name	Type	Required	Description
environment	String	true	Nucleus environment to deploy service