Github Action for Figure Development

Bash

Set Env Vars From SSM Parameters

Parameters:

• aws-region: The AWS region to use.
• parameters: The parameters in format "env_var_name1=ssm_path1;env_var_name2=ssm_path2".
• service-name: The service name.

- uses: FigurePOS/github-actions/.github/actions/set-env-vars-from-ssm-parameters@v1
  with:
    aws-region: ${{ inputs.aws-region }}
    parameters: "DATADOG_API_KEY=terraform/datadog/api_key;DATADOG_APP_KEY=terraform/datadog/app_key"
    service-name: ${{ inputs.service-name }}

Node.js

Set Up Node.js

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Set Up Node.js
        uses: FigurePOS/github-actions/.github/actions/setup-node@v1

Install Node.js Dependencies

Installs Node.js dependencies using yarn and authenticates Figure private Github package registry.

Parameters:

• additional-cache-path: Additional path to cache, default: "".
• directory: Directory to install dependencies in, default: ".".
• prod: Whether to install only prod dependencies, default: false.

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Install Dependencies
        uses: FigurePOS/github-actions/.github/actions/install-dependencies@v1
        with:
          prod: false

Check Node.js License Compliance

Checks the license compliance of Node.js dependencies.

- uses: FigurePOS/github-actions/.github/actions/node-license-compliance@v1

Git

Configure Git user

Parameters:

• email: Email address to use for the git user, default: github-actions[bot]@users.noreply.github.com.
• name: Name to use for the git user, default: github-actions[bot].

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Configure Git user
        uses: FigurePOS/github-actions/.github/actions/git-configure-user@v1

Get Git commit message from history

Parameters:

• offset: Commit offset from HEAD to get the message from. Default is 1 (current commit). Use 2 for the previous commit, 3 for the commit before that, etc.

Outputs:

• hash: Hash of the commit.
• message: Message of the commit.

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Get Git Message
        id: get-git-message
        uses: FigurePOS/github-actions/.github/actions/git-get-message@v1

      - name: Trigger DEV Build on EAS
        run: |
          eas build --profile development --platform ${{ github.event.inputs.platform }} --message "${{ steps.get-git-message.outputs.message }}" --no-wait --non-interactive

Docker

Build Image

Builds docker image and uploads it to artifacts. Use docker-load-image in subsequent job to work with the image.

Parameters:

• repository-name: Name of the ECR repository.
• service-name: Service name.

Load Image

Downloads the image built by docker-build-image job and loads it to docker.

Parameters:

• service-name: Service name.

Push Image

Pushes the image built by docker-build-image job to ECR.

Parameters:

• repository-name: Name of the ECR repository.
• service-name: Service name.

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Build image
        uses: FigurePOS/github-actions/.github/actions/docker-build-image@v1
        with:
          repository-name: figure/makeitbutter-api
          service-name: make-it-butter-api
  
  push:
    needs:
      - build
    steps:
      - name: Load image
        uses: FigurePOS/github-actions/.github/actions/docker-load-image@v1
        with:
          service-name: make-it-butter-api
      
      - name: Push image
        uses: FigurePOS/github-actions/.github/actions/docker-push-image@v1
        with:
          repository-name: figure/makeitbutter-api
          service-name: make-it-butter-api

Expo

Get Expo App Name

Parameters:

• environment: Environment to get the app name for.
• platform: Platform to get the app name for.

Outputs:

• appName: App name of the project.

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    
    - name: Setup EAS
      uses: expo/expo-github-action@v8
      with:
        eas-version: latest
        token: ${{ secrets.EXPO_TOKEN }}

    - name: Get App Info
      uses: FigurePOS/github-actions/.github/actions/eas-get-app-info@v1
      id: get-app-info
      with:
        environment: ${{ inputs.environment }}
        platform: ${{ inputs.platform }}

    - name: Send Slack Notification
      uses: FigurePOS/github-actions/.github/actions/buddy-notify-deploy-mobile@v1
      if: ${{ inputs.should-notify }}
      with:
          app-name: ${{ steps.get-app-info.outputs.app-name }}
          ...

Bugsnag

Upload Bugsnag Source Maps for Mobile

Parameters:

• api-key: Auth token for the Bugsnag API.
• version: Version of the app.
• platform: Platform to upload source maps for. Options: ios, android, all.
• environment: Environment to upload source maps for.

on: push
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    
    - name: Upload Source Maps to Bugsnag
      uses: FigurePOS/github-actions/.github/actions/bugsnag-upload-source-maps-mobile@v1
      with:
        api-key: ${{ secrets.BUGSNAG_API_KEY }}
        version: ${{ inputs.version }}
        platform: ${{ inputs.platform }}
        environment: ${{ inputs.environment }}

Terraform

Apply

Youu need to run terraform-init job beforehand.

Parameters:

• aws-account-id
• env
• service-name

  - uses: "FigurePOS/github-actions/.github/actions/terraform-apply@v1"
    with:
      aws-region: ${{ inputs.aws-region }}
      env: ${{ inputs.env }}
      service-name: ${{ inputs.service-name }}

Init

Parameters:

• aws-account-id
• db-tunnel-mapping
• env
• service-name

  - uses: "FigurePOS/github-actions/.github/actions/terraform-init@v1"
    with:
      aws-region: ${{ inputs.aws-region }}
      db-tunnel-mapping: ${{ inputs.db-tunnel-mapping }}
      env: ${{ inputs.env }}
      service-name: ${{ inputs.service-name }}

Plan

Youu need to run terraform-init job beforehand.

Parameters:

• aws-account-id
• env
• service-name

  - uses: "FigurePOS/github-actions/.github/actions/terraform-plan@v1"
    with:
      aws-region: ${{ inputs.aws-region }}
      env: ${{ inputs.env }}
      service-name: ${{ inputs.service-name }}

Validate

Youu need to run terraform-init job beforehand.

Parameters:

• aws-account-id
• env
• service-name

  - uses: "FigurePOS/github-actions/.github/actions/terraform-validate@v1"
    with:
      aws-region: ${{ inputs.aws-region }}
      env: ${{ inputs.env }}
      service-name: ${{ inputs.service-name }}

Buddy

Notify about Mobile Deployment

Parameters:

• app-name: Name of the app.
• app-version: Version of the app.
• author: Author of the build (optional).
• build-type: Type of the build. Options: over-the-air, native.
• build-url: URL of the build (optional).
• commit-hash (optional)
• commit-message
• environment: Options: development, production.
• platform: Options: ios, android, all.
• trigger-url: Buddy URL endpoint.

  - uses: "FigurePOS/github-actions/.github/actions/buddy-notify-deploy-mobile@v1"
    with:
      app-name: Figure POS
      app-version: 1.0.0
      build-type: native
      commit-message: "fix: typo"
      environment: production
      paltform: all
      trigger-url: ${{ secrets.BUDDY_TRIGGER_URL }}

Notify about Service Deployment

Parameters:

• commit-hash: Commit hash of the build, last commit hash by default.
• commit-message: Commit message of the build, last commit message by default.
• service-name
• trigger-url: Buddy URL endpoint.

  - uses: "FigurePOS/github-actions/.github/actions/buddy-notify-deploy-service@v1"
    with:
      commit-hash: 1e17438
      commit-message: "fix: typo"
      service-name: fgr-service-account
      trigger-url: ${{ secrets.BUDDY_TRIGGER_URL }}

Notify about Failed CI Pipeline

Parameters:

• service-name
• trigger-url: Buddy URL endpoint.

  - uses: "FigurePOS/github-actions/.github/actions/buddy-notify-fail-service@v1"
    if: failure() && github.ref == 'refs/heads/master'
    with:
      service-name: fgr-service-account
      trigger-url: ${{ secrets.BUDDY_TRIGGER_URL }}

Serverless

Deploy

Parameters:

• aws-account-id
• env
• service-name

  - uses: "FigurePOS/github-actions/.github/actions/serverless-deploy@v1"
    with:
      aws-account-id: ${{ inputs.aws-account-id }}
      env: ${{ inputs.env }}
      service-name: ${{ inputs.service-name }}

---

Development

We use GitHub releases to install specific versions of the actions. Note that GitHub Actions do not support semantic versioning by default.

If you want to allow it, you need to manually retag the major/minor version after each release. For example, when you release version v1.3.2, you need to retag the release with v1.3 and v1 tags manually.