You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
</a>
5
5
<h3align="center">sweetr.dev</h3>
6
6
<palign="center">
7
-
<i>Optimize delivery, enhance developer experience, and foster team growth with the sweetest Developer Intelligence Platform.</i>
7
+
<i>Insights and automations your dev team will actually trust. Free to <ahref="https://docs.sweetr.dev/get-started/self-host"target="blank">self-host</a>.</i>
8
8
</p>
9
9
10
10
<palign="center">
@@ -22,16 +22,16 @@
22
22
Spot work that needs attention; unblock your team; gather data for retros, 1:1s and performance reviews.
Copy file name to clipboardExpand all lines: apps/docs/platform/deployments.mdx
+47-16Lines changed: 47 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,52 @@ Deployments track when a version of an application is deployed to an environment
18
18
19
19
Filter deployments by application, environment, and date range to find exactly what you need.
20
20
21
+
## Setting up deployments for DORA Metrics
22
+
23
+
To get accurate [DORA metrics](/metrics-and-insights/dora), you need to track deployments in Sweetr.
24
+
25
+
<Steps>
26
+
<Steptitle="Create an application">
27
+
Deployments belong to [Applications](/platform/applications). Create at least one application for each deployable unit in your repositories.
28
+
29
+
You can create applications manually from the UI, or let Sweetr auto-create them when you send your first deployment via the API.
30
+
31
+
<Tip>
32
+
If you have a monorepo, create a separate application for each service and configure its **subdirectory** so pull requests are correctly linked to the right application.
33
+
</Tip>
34
+
35
+
</Step>
36
+
<Steptitle="Choose a deployment trigger">
37
+
Each application needs a deployment trigger so Sweetr knows when a deployment happens. Pick the one that fits your workflow:
38
+
39
+
<CardGroupcols={2}>
40
+
<Cardtitle="API Webhook"icon="webhook">
41
+
Call the [POST /v1/deployments](/api-reference/deployments/create-deployment) endpoint from your CI/CD pipeline (e.g., GitHub Actions, GitLab CI, Jenkins) whenever a deployment completes. **Recommended** for the most accurate metrics, since it captures the real deployment time.
42
+
</Card>
43
+
44
+
<Cardtitle="Pull Request Merge"icon="git-merge">
45
+
Automatically create a deployment when a pull request is merged to a target branch. Simpler to set up, but uses the merge time as an approximation of deployment time.
46
+
</Card>
47
+
</CardGroup>
48
+
49
+
Configure the trigger in your application's **Deployment settings**. For merge-based triggers, set the **target branch** to the branch that represents production (e.g., `main`).
50
+
51
+
</Step>
52
+
<Steptitle="Send your first deployment">
53
+
Trigger a deployment by calling the API or merging a pull request to your target branch. Sweetr will record it and start building your DORA metrics.
54
+
</Step>
55
+
<Steptitle="Backfill historical data">
56
+
Want DORA metrics from day one? Start with the **Pull Request Merge** trigger, then go to **Settings → Workspace** and click **Resync all historical data**. Sweetr will create deployments for every previously merged PR to your target branch, giving you historical metrics right away.
57
+
58
+
Once you have your baseline, you can switch to the **API Webhook** trigger for more accurate deployment times going forward.
59
+
60
+
<Tip>
61
+
This is a great way to get visibility into your team's delivery history without waiting for new deployments to come in.
62
+
</Tip>
63
+
64
+
</Step>
65
+
</Steps>
66
+
21
67
## Change type
22
68
23
69
Sweetr automatically determines the **change type** for each deployment by comparing commits against the previous deployment:
@@ -26,21 +72,6 @@ Sweetr automatically determines the **change type** for each deployment by compa
26
72
-**Rollback**: The deployment reverts to a previous version.
27
73
-**No Change**: A redeployment of the same version.
28
74
29
-
## Deployment triggers
30
-
31
-
Deployments can be tracked through two different triggers:
Copy file name to clipboardExpand all lines: apps/web/src/app/automations/settings/pr-title-check/components/form-pr-title-check-settings/form-pr-title-check-settings.tsx
0 commit comments