Skip to main content

Environments & Releases

The Seller Releases feature allows for the creation of an external backup, environments, and maintaining a version history from the Git Repository or an existing seller.

How It Works​

This example explains how to set up development and production environments using either Git repositories or existing sellers as sources. The setup can be extended to include multiple environments, Git branches, or sellers based on your needs.

Requirements​

You have to enable the seller releases feature in the Settings -> Environments.

Git-Sync​

Requirements

  • Empty Git Repository
  • Two Sellers in Staqr: one for Development and one for Production

1. Push Flow to Repository​

After making changes in the flow:

  1. Click the 3-dot menu near the flow name
  2. Select "Push to Git"
  3. Add commit message and push

2. Deleting Flows​

When you delete a flow from a seller configured with Git sync (Release from Git), it will automatically delete the flow from the repository.

Seller-Sync​

1. Initialize Sellers​

  • Create a source seller (e.g., Development)
  • Create a target seller (e.g., Production)

2. Develop​

  • Build and test your flows in the source seller
  • When ready, sync changes to the target seller using releases

Creating a Release​

note

Credentials are not synced automatically. Create identical credentials with the same names in both environments manually.

You can create a release in two ways:

  1. From Git Repository:

    • Click "Create Release" and select "From Git"

  2. From Existing Seller:

    • Click "Create Release" and select "From Seller"
    • Choose the source seller to sync from

For both methods:

  • Review the changes between environments
  • Choose the operations you want to perform:
    • Update Existing Flows: Synchronize flows that exist in both environments
    • Delete Missing Flows: Remove flows that are no longer present in the source
    • Create New Flows: Add new flows found in the source
  • Confirm to create the release

Important Notes​

  • Enabled flows will be updated and republished (failed republishes become drafts)
  • New flows start in a disabled state

Approval Workflow (Optional)​

To manage your approval workflow, you can use Git by creating two branches: development and production. Then, you can use standard pull requests as the approval step.

GitHub action​

This GitHub action can be used to automatically pull changes upon merging.

tip

Don't forget to replace INSTANCE_URL and SELLER_ID, and add STAQR_API_KEY to the secrets.

name: Auto Deploy
on:
  workflow_dispatch:
  push:
    branches: [ "main" ]
jobs:
  run-pull:
    runs-on: ubuntu-latest
    steps:
      - name: deploy
        # Use GitHub secrets
        run: |
          curl --request POST \
            --url {INSTANCE_URL}/api/v1/git-repos/pull \
            --header 'Authorization: Bearer ${{ secrets.STAQR_API_KEY }}' \
            --header 'Content-Type: application/json' \
            --data '{
              "sellerId": "{SELLER_ID}"
            }'