export-action

This repo contains the GitHub Action that can be used to pull Superblocks application component changes from a connected GitHub repo to Superblocks.

See the Source Control documentation for more information.

Description

Pull application-specific components source code from Superblocks

Usage

name: Sync application component changes from Superblocks
on: [push]

jobs:
  superblocks-pull:
    runs-on: ubuntu-latest
    name: Pull from Superblocks
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Pull
        uses: superblocksteam/export-action@v1
        id: pull
        with:
          token: ${{ secrets.SUPERBLOCKS_TOKEN }}

The above shows a standalone workflow. If you want to incorporate it as part of an existing workflow/job, simply copy the checkout and push steps into your workflow.

You can also pin the action to a specific release version:

      - name: Pull
        uses: superblocksteam/[email protected]

EU region

If your organization uses Superblocks EU, set the domain to eu.superblocks.com in the Pull step.

      ...

      - name: Pull
        uses: superblocksteam/export-action@v1
        id: pull
        with:
          token: ${{ secrets.SUPERBLOCKS_TOKEN }}
          domain: eu.superblocks.com

Inputs

INPUT	TYPE	REQUIRED	DEFAULT	DESCRIPTION
domain	string	false	"app.superblocks.com"	The Superblocks domain where applications are hosted
path	string	false	"."	The relative path from repo root to the Superblocks root directory. This is where the ~.superblocks/superblocks.json config file is located.
sha	string	false	"HEAD"	Commit to pull changes for
token	string	true		The Superblocks access token to use

Outputs

No outputs.