Review Environments

Manage review environments in sfp server

sfp server review-envs acquire

Acquire a review environment for use, marking it as in-use for a specified duration

USAGE
  $ sfp server review-envs acquire -r <value> -t pr|issue|user|custom -i <value> -d <value> --used-by <value> [--json] [-e
    <value>] [-t <value>] [--sfp-server-url <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] [-w] [--poll-interval <value>] [--max-wait-time
    <value>] [--domain <value>]

FLAGS
  -d, --duration=<value>            (required) Duration in minutes for which the environment is needed (1-480)
  -e, --email=<value>               [env: SFP_SERVER_USER] Email address for authenticated user. Ignored if
                                    --application-token is provided.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -i, --id=<value>                  (required) Assignment identifier (e.g., PR number, issue number, username, or custom
                                    ID)
  -r, --repository=<value>          (required) Repository identifier in format owner/repo
  -t, --application-token=<value>   [env: SFP_SERVER_TOKEN] Application token for CI/CD authentication. Takes precedence
                                    over --email.
  -t, --type=<option>               (required) Type of assignment (pr, issue, user, or custom)
                                    <options: pr|issue|user|custom>
  -w, --wait                        Wait for the environment to become available if currently in use
      --domain=<value>              Specific domain to acquire (for multi-domain assignments)
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --max-wait-time=<value>       [default: 480] Maximum time to wait in minutes when --wait is used (default: 480
                                    minutes/8 hours)
      --poll-interval=<value>       [default: 30] Polling interval in seconds when waiting (10-300, default: 30)
      --sfp-server-url=<value>      [env: SFP_SERVER_URL] URL of the SFP server. Can be set via environment variable
                                    `SFP_SERVER_URL` or config: sfp config:set server-url
      --used-by=<value>             (required) Identifier of the process or user acquiring the environment

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Acquire a review environment for use, marking it as in-use for a specified duration

EXAMPLES
  $ sfp server review-envs acquire --type pr --id 123 --repository myorg/myrepo --duration 30 --used-by "ci-pipeline-123"

  $ sfp server review-envs acquire --type user --id john.doe --repository myorg/myrepo --duration 60 --used-by "local-dev"

  $ sfp server review-envs acquire --type custom --id demo-session --repository myorg/myrepo --duration 120 --used-by "demo-process"

  $ sfp server review-envs acquire --type pr --id 123 --repository myorg/myrepo --duration 30 --used-by "ci-pipeline-123" --wait

  $ sfp server review-envs acquire --type pr --id 123 --repository myorg/myrepo --duration 30 --used-by "ci-pipeline-123" --wait --poll-interval 60

  $ sfp server review-envs acquire --type pr --id 123 --repository myorg/myrepo --duration 30 --used-by "ci-pipeline-123" --wait --max-wait-time 120

See code: src/commands/server/review-envs/acquire.tsarrow-up-right

sfp server review-envs assign

Assign a review environment from a pool

See code: src/commands/server/review-envs/assign.tsarrow-up-right

sfp server review-envs extend

Extend a review environment assignment

See code: src/commands/server/review-envs/extend.tsarrow-up-right

sfp server review-envs list

List review environment assignments

See code: src/commands/server/review-envs/list.tsarrow-up-right

sfp server review-envs release

Release a review environment from use, marking it as idle for subsequent use within the same assignment

See code: src/commands/server/review-envs/release.tsarrow-up-right

sfp server review-envs rules create

Create a pool assignment rule for automatic pool resolution

See code: src/commands/server/review-envs/rules/create.tsarrow-up-right

sfp server review-envs rules delete ID

Delete a pool assignment rule

See code: src/commands/server/review-envs/rules/delete.tsarrow-up-right

sfp server review-envs rules list

List pool assignment rules

See code: src/commands/server/review-envs/rules/list.tsarrow-up-right

sfp server review-envs rules match

Test which pool would be assigned for given branch and domain

See code: src/commands/server/review-envs/rules/match.tsarrow-up-right

sfp server review-envs rules update ID

Update a pool assignment rule

See code: src/commands/server/review-envs/rules/update.tsarrow-up-right

sfp server review-envs unassign

Unassign a review environment

See code: src/commands/server/review-envs/unassign.tsarrow-up-right

Last updated

Was this helpful?