Fetches a review environment from a specified pool and assigns it to a pull request/issue.
The commands are only available in sfp-pro (August 24 onwards) and currently limited to GitHub. Using these commands requires an equivalent APP_ID & PRIVATE_KEY in your environment variable.
--repository: The repository path that stores the pool lock (default: current repo).
--pool: The name of the pool to fetch the review environment from (required).
--poolType: The type of the pool, either sandbox or scratchorg (required).
--branch: The pull request branch to fetch the environment for (required).
--issue: The pull request number to assign the environment to, or a unique id that will be used subsequently to identify (required).
--devhubAlias: The DevHub alias associated with the pool (default: devhub).
--wait: Time in minutes to wait for an environment to become available (default: 20).
--leaseFor: Time in minutes typically this environment is leased for during similar operations
Checks if an environment is already assigned to the issue.
If assigned, verifies if the previous lease has expired based on the leaseFor duration. If a job has not released the environment within the earlier mentioned leaseFor, the new job will be provided the environment
If no environment is assigned or the environment assigned to the issue has expired, fetches a new environment from the pool.
Automatically marks the fetched or reassigned environment as "InUse".
Waits for up to the specified wait time if no environment is immediately available.
The environment remains valid for 24 hours from assignment, regardless of the leaseFor duration.
The leaseFor parameter determines how long the current process can use the environment before it becomes available for reassignment for a different job within the same issue.
Checks the status of review environments assigned to a specific pull request/issue.
The commands are only available in sfp-pro (August 24 onwards) and currently limited to GitHub. Using these commands requires an equivalent APP_ID & PRIVATE_KEY in your environment variable.
--repository: The repository path that stores the pool lock (default: current repo).
--issue: The pull request number to assign the environment to, or a unique id that will be used subsequently to identify (required).
--pool: The name of the pool to filter by (optional).
--poolType: The type of the pool to filter by, either sandbox or scratchorg (optional).
--branch: The pull request branch to filter by (optional).
Searches the repository's stored environment data for environments associated with the specified issue.
Returns details of any found environments, including:
Environment name or username
Environment type (sandbox or scratch org)
Pool the environment belongs to
Associated pull request branch
Environment status and expiration date
This command is typically used as needed, not within the regular pull request workflow.
It's useful for verifying environment details or troubleshooting.
Extends the lease of a review environment assigned to a specific issue.
The commands are only available in sfp-pro (August 24 onwards) and currently limited to GitHub. Using these commands requires an equivalent APP_ID & PRIVATE_KEY in your environment variable.
--repository: The repository path that stores the pool lock (default: current repo).
--issue: The pull request number to assign the environment to, or a unique id that will be used subsequently to identify (required).
Locates the environment assigned to the specified issue.
Extends the overall validity of the environment by an additional 24 hours from the current time.
This command is useful when more time is needed for thorough testing or when waiting for stakeholder approval.
It extends the overall validity of the environment, not the lease time for a specific process.
Use judiciously to avoid unnecessarily tying up resources.
Updates the status of a review environment assigned to a specific issue.
The commands are only available in sfp-pro (August 24 onwards) and currently limited to GitHub. Using these commands requires an equivalent APP_ID & PRIVATE_KEY in your environment variable.
--repository: The repository path that stores the pool lock (default: current repo).
--issue: The pull request number to assign the environment to, or a unique id that will be used subsequently to identify (required).
--status: The status to transition the review environment to (required). Options: 'InUse', 'Available', 'Expired'
Locates the environment assigned to the specified issue.
Updates the status of the environment to the specified status.
'InUse': The environment is currently being used by automated checks or another automated process.
'Available': The environment is available for reuse by another automation within the same issue's context.
'Expired': The environment will be picked up by Pool commands for deletion.
This command doesn't reflect the state of the pull request, but rather the current usage state of the environment within the issue's context.
Transitioning to 'Available' before the lease expires allows for efficient reuse within the same issue.
Removes the assignment of a review environment from an issue.
The commands are only available in sfp-pro (August 24 onwards) and currently limited to GitHub. Using these commands requires an equivalent APP_ID & PRIVATE_KEY in your environment variable.
--repository: The repository path that stores the pool lock (default: current repo).
--issue: The pull request number to assign the environment to, or a unique id that will be used subsequently to identify (required).
--returntopool: If set to true, the environment will be returned to the pool for reuse. If false or not set, it will be marked as expired.
Locates the environment assigned to the specified issue.
Removes the assignment of the environment from the issue.
Based on the --returntopool flag:
If true: Marks the environment as available for reuse within the pool.
If false or not set: Marks the environment as expired, to be picked up by Pool commands for deletion.
This command should be used when a review environment is no longer needed for an issue.
Consider carefully whether to return the environment to the pool or mark it as expired based on your project's needs and the state of the environment.