Skip to content

Workflow Repository Seeding Checklist

Use this checklist whenever you migrate a customer onto definition-based workflows or refresh a seed repository in a new environment. It keeps projects aligned with their .kiket source of truth and catches the easy-to-miss prerequisites.

1. Pre-flight Checks

  • Source repository cloned and accessible by the Kiket sync user (SSH deploy key or HTTPS token).
  • Default branch contains a definitions/<template>/.kiket/ tree with model_version pinned and no duplicate workflow IDs.
  • Required secrets (GitHub/Bitbucket tokens, webhook endpoints, extension credentials) already stored in Settings → Integrations.
  • Environment feature flags match the template (extensions, AI aides, command palette entries).

2. Initial Sync

  1. Navigate to Settings → Workflow Sources and add the repository URL plus branch.
  2. Run Sync Now. For large templates keep the window open; the dispatcher streams progress through the status sidebar.
  3. Confirm the sync job enqueued LoadProjectConfigurationJob in Sidekiq; the job should finish without retries.

3. Post-sync Validation

  • Workflows & boards visible under Project → Boards, including any lane automation badges.
  • Issue types, custom fields, and templates appear in Project → Configuration.
  • Extensions loaded with the expected manifest actions (see Project → Automations).
  • Usage policies and permissions updated (check Settings → Access Control).

4. Data Hygiene

  • Remove the temporary storage/workflow_sources/<project> folder if the repo should remain remote-only.
  • Snapshot the ConfigurationLoader logs for the customer’s runbook; unresolved warnings go to support.
  • Schedule nightly definition syncs and alerting via workflow repository settings.

5. Handoff

  • Share the seeded board links with the customer champion.
  • Provide a quick-start README that explains how to submit PRs against their definition repo.
  • Record the sync in the organization timeline so support can trace future configuration changes.

Keep this checklist handy for every onboarding—consistency saves hours of follow-up support.