Tailor Platform Actions

Reusable GitHub Actions for Tailor Platform.

Actions

deploy

Deploy an application to Tailor Platform. Handles token acquisition, workspace provisioning, code generation, and deployment.

Prerequisites: The caller is responsible for checkout, Node.js setup, package manager setup, and dependency installation. This keeps the action package-manager agnostic.

Usage

jobs:
  deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version-file: package.json
          cache: pnpm
      - run: pnpm install --frozen-lockfile
      - uses: tailor-platform/actions/deploy@v1
        with:
          workspace-name: my-app
          workspace-region: asia-northeast
          organization-id: ${{ vars.TAILOR_PLATFORM_ORGANIZATION_ID }}
          folder-id: ${{ vars.TAILOR_PLATFORM_FOLDER_ID }}
          platform-client-id: ${{ secrets.PLATFORM_MACHINE_USER_CLIENT_ID }}
          platform-client-secret: ${{ secrets.PLATFORM_MACHINE_USER_CLIENT_SECRET }}

Inputs

Name	Required	Default	Description
workspace-name	Yes		Workspace name
workspace-region	Yes		Workspace region
organization-id	Yes		Organization ID
folder-id	Yes		Folder ID
working-directory	No	.	Working directory (for monorepo setups)
platform-client-id	Yes		OAuth2 client ID for machine user
platform-client-secret	Yes		OAuth2 client secret for machine user

Outputs

Name	Description
workspace-id	Workspace ID (created or existing)

Secrets setup

gh secret set PLATFORM_MACHINE_USER_CLIENT_ID
gh secret set PLATFORM_MACHINE_USER_CLIENT_SECRET

Scaffold with Tailor SDK CLI

The tailor-sdk setup github command generates a workflow file that uses this action, with package manager auto-detection.

---

plan

Show planned changes by running dry-run against the target workspace. Merges the base branch and runs tailor-sdk apply --dry-run, then comments the result on the PR.

Prerequisites: Same as deploy - checkout, Node.js setup, package manager setup, and dependency installation.

Usage

jobs:
  plan:
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version-file: package.json
          cache: pnpm
      - run: pnpm install --frozen-lockfile
      - uses: tailor-platform/actions/plan@v1
        with:
          workspace-id: ${{ vars.TAILOR_PLATFORM_WORKSPACE_ID }}
          platform-client-id: ${{ secrets.PLATFORM_MACHINE_USER_CLIENT_ID }}
          platform-client-secret: ${{ secrets.PLATFORM_MACHINE_USER_CLIENT_SECRET }}
          github-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

Name	Required	Default	Description
workspace-id	Yes		Workspace ID to run dry-run against
working-directory	No	.	Working directory (for monorepo setups)
platform-client-id	Yes		OAuth2 client ID for machine user
platform-client-secret	Yes		OAuth2 client secret for machine user
github-token	Yes		GitHub token for commenting on PR

PR Comment

The action posts (or updates) a comment on the PR with the dry-run output:

• ✅ Success: Shows the planned changes
• ❌ Failure: Shows the error output

The comment is automatically updated on subsequent runs.

License

MIT