Authenticate to an Enviroment with Lock (SFP Server)

The authToEnvironmentWithLock action provides secure authentication with exclusive environment locking through SFP server. This ensures only one workflow can access an environment at a time, making it ideal for critical operations that require exclusive access such as deployments, data migrations, or destructive operations.

Overview

When performing critical operations on Salesforce environments, you often need to ensure exclusive access to prevent conflicts. The authentication with lock action provides:

• Exclusive environment access through SFP server's locking mechanism
• Automatic wait functionality when environments are already locked
• Lock tracking with ticket IDs for proper cleanup
• Prevention of concurrent operations that could cause conflicts
• Configurable lock duration based on operation requirements

This makes it perfect for:

• Production deployments
• Data migration operations
• Destructive changes (metadata deletion)
• Schema modifications
• Any operation requiring guaranteed exclusive access

How It Works

The action follows this workflow:

Prerequisites

Before using this action in your custom workflow, ensure:

1. Your workflow uses the sfops Docker image - Required for SFP CLI and dependencies:

   jobs:
     your-job:
       runs-on: ubuntu-latest
       container: ${{ sfops.sfops_docker_image }}

2. SFP server credentials are configured:

   • SFP_SERVER_URL as a variable
   • SFP_SERVER_TOKEN as a secret

3. Environment is registered in SFP server - This action only works with environments managed by SFP server

Referencing the Action

The authToEnvironmentWithLock action is located in your sfops repository. In all examples below, the action is referenced using:

uses: ${{ sfops.repo_owner }}/${{ sfops.action_repository }}/authToEnvironmentWithLock@main

The ${{ sfops.repo_owner }}/${{ sfops.action_repository }} template variables are automatically replaced with your organization and sfops repository name (e.g., flxbl-io/sfops-gh-actions).

Basic Usage

Simple Authentication with Lock

The minimal configuration for exclusive environment access:

name: Deploy with Exclusive Access
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Target environment'
        required: true
        type: string

jobs:
  deploy-with-lock:
    runs-on: ubuntu-latest
    container: ${{ sfops.sfops_docker_image }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Lock and Authenticate
        id: auth
        uses: ${{ sfops.repo_owner }}/${{ sfops.action_repository }}/authToEnvironmentWithLock@main
        with:
          environment: ${{ inputs.environment }}
          repository: ${{ github.repository }}
          reason: "Deployment from workflow"
          sfp-server-url: ${{ vars.SFP_SERVER_URL }}
          sfp-server-token: ${{ secrets.SFP_SERVER_TOKEN }}

      - name: Deploy Components
        run: |
          # Your deployment commands here
          sfp deploy --target-org ${{ steps.auth.outputs.alias }}

      - name: Unlock Environment
        if: always()
        run: |
          sfp server environment unlock \
            --name ${{ inputs.environment }} \
            --repository ${{ github.repository }} \
            --lock-ticket-id ${{ steps.auth.outputs.ticket_id }}

With Custom Lock Duration

Configure how long to hold the lock:

- name: Lock for Extended Operation
  id: auth
  uses: ${{ sfops.repo_owner }}/${{ sfops.action_repository }}/authToEnvironmentWithLock@main
  with:
    environment: production
    repository: ${{ github.repository }}
    duration: 120  # Lock for 2 hours
    reason: "Large data migration operation"
    sfp-server-url: ${{ vars.SFP_SERVER_URL }}
    sfp-server-token: ${{ secrets.SFP_SERVER_TOKEN }}

Fail Fast Without Waiting

Configure the action to fail immediately if the environment is locked:

- name: Try to Lock (No Wait)
  id: auth
  uses: ${{ sfops.repo_owner }}/${{ sfops.action_repository }}/authToEnvironmentWithLock@main
  with:
    environment: ${{ inputs.environment }}
    repository: ${{ github.repository }}
    reason: "Quick validation check"
    wait: false  # Fail immediately if locked
    sfp-server-url: ${{ vars.SFP_SERVER_URL }}
    sfp-server-token: ${{ secrets.SFP_SERVER_TOKEN }}

Input Reference

Output Reference

Common Use Cases

Production Deployments

Use locks to ensure only one deployment happens at a time in production environments.

Data Operations

Prevent concurrent data modifications that could cause inconsistencies.

Schema Changes

Ensure exclusive access when modifying object structures or relationships.

Destructive Changes

Protect against conflicts when removing metadata components.

Maintenance Windows

Lock environments during scheduled maintenance operations.

Troubleshooting

Lock Not Released

If a workflow fails without releasing a lock:

1. Check the SFP server UI for active locks
2. Use the lock ticket ID from workflow logs
3. Manually unlock using: sfp server environment unlock --lock-ticket-id <ticket>

Authentication Failures

Ensure:

• Environment is registered in SFP server
• SFP server credentials are correct
• Environment has valid authentication configured

Lock Wait Timeout

If waiting for a lock times out:

• Check who holds the current lock in SFP server
• Coordinate with the team member
• Consider increasing the wait timeout or retry later