Skip to content

Setup Commands

Commands for setting up project infrastructure.

setup

Set up project infrastructure.

Usage

tailor-sdk setup [command]

Commands

CommandDescription
setup githubGenerate a GitHub Actions deploy workflow. (beta)

See Global Options for options available to all commands.

setup github

Generate a GitHub Actions deploy workflow. (beta)

Usage

tailor-sdk setup github [options]

Options

OptionAliasDescriptionRequiredDefault
--workspace-name <WORKSPACE_NAME>-nWorkspace name (defaults to the config 'name')No-
--branch <BRANCH>-Branch target: deploy trigger branch (defaults to the detected default branch). Tag target: tag-reachability guard branch (no guard when omitted)No-
--tag-Generate a tag target (deploy on tag push)Nofalse
--tag-pattern <TAG_PATTERN>-Tag glob to match (requires --tag; defaults to v*)No-
--environment <ENVIRONMENT>-GitHub Environment for the plan/deploy jobs (defaults to the workspace name)No-
--no-plan-Disable the plan job for a branch target (cannot be combined with --tag)Nofalse
--dir <DIR>-dApp directory (for monorepo setups)No"."
--force-Discard hand edits / take over unmanaged files and regenerateNofalse

See Global Options for options available to all commands.

Further reading