Best Practices

Keep your workflow-as-code implementation healthy with these tips.

Configuration Hygiene

• Treat .kiket/ directories like application code—require pull requests and reviews.
• Use CI to lint workflows, boards, and DSAL files before merging.
• Tag releases of configuration repositories so you can roll back quickly.

Repository Strategy

• Store shared defaults in an organization repository and attach it to every project.
• Create per-team repositories for specific workflows or experiments.
• Document ownership in README.md within each configuration repository.

Sync Discipline

• Prefer webhook-driven syncs to keep boards up to date automatically.
• Run manual syncs before major ceremonies (sprint planning, retrospectives) to ensure the latest configuration is live.
• Monitor sync jobs for failures and fix YAML errors promptly.

Automation

• Start with lightweight actions (notifications) before automating critical path decisions.
• Version third-party integration secrets via extensions so you can rotate them outside of YAML.
• Leverage provenance metadata to trace issues back to configuration commits during incidents.

Analytics

• Build metrics incrementally; validate them against historical data.
• Keep dashboards focused—too many widgets reduce signal.
• Archive unused metrics to avoid clutter.

Security

• Rotate GitHub tokens and extension keys regularly.
• Restrict who can approve changes to .kiket/ directories.
• Enable audit log exports for compliance needs.

Following these practices ensures Kiket stays reliable, auditable, and aligned with your engineering processes.