diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index 1178f3c1c2d..a8ddc99d685 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -2107,6 +2107,10 @@ export const platform: NavMenuConstant = { name: 'Compute', url: '/guides/platform/manage-your-usage/compute', }, + { + name: 'Branching', + url: '/guides/platform/manage-your-usage/branching', + }, ], }, { diff --git a/apps/docs/content/guides/platform/manage-your-usage.mdx b/apps/docs/content/guides/platform/manage-your-usage.mdx index 1dbf21262be..d9a4689b723 100644 --- a/apps/docs/content/guides/platform/manage-your-usage.mdx +++ b/apps/docs/content/guides/platform/manage-your-usage.mdx @@ -3,6 +3,7 @@ id: 'manage-your-usage' title: 'Manage your usage' --- -Each subpage breaks down a specific metric and details what you're charged for, how costs are calculated, and how to optimize usage and reduce costs. +Each subpage breaks down a specific usage item and details what you're charged for, how costs are calculated, and how to optimize usage and reduce costs. -- [Compute](/docs/guides/platform/manage-your-usage/compute) \ No newline at end of file +- [Compute](/docs/guides/platform/manage-your-usage/compute) +- [Branching](/docs/guides/platform/manage-your-usage/branching) \ No newline at end of file diff --git a/apps/docs/content/guides/platform/manage-your-usage/branching.mdx b/apps/docs/content/guides/platform/manage-your-usage/branching.mdx new file mode 100644 index 00000000000..4574d4ae6bb --- /dev/null +++ b/apps/docs/content/guides/platform/manage-your-usage/branching.mdx @@ -0,0 +1,67 @@ +--- +id: 'manage-usage-branching' +title: 'Manage Branching usage' +--- + +## What you are charged for +Each [Preview branch](/docs/guides/deployment/branching) is a separate environment with all Supabase services (Database, Auth, Storage, etc.). You're charged for usage within that environment—such as [Compute](/docs/guides/platform/manage-your-usage/compute), Disk Size, Egress, and Storage—just like the project you branched from. + +Usage by Preview branches counts toward your subscription plan's free quota. + +## How charges are calculated +Refer to individual [usage items](/docs/guides/platform/manage-your-usage) for details on how charges are calculated. Branching charges are the sum of all these items. + +### Branching usage on your invoice +Compute incurred by Preview branches is shown as "Branching Compute Hours" on your invoice. Other usage items are not shown separately for branches. + +## Pricing +There is no fixed fee for a Preview branch. You only pay for the usage it incurs. With Compute costs of $0.01344 per hour, a branch running on Micro Compute size starts at $0.32 per day. + +## Billing examples +The project has a Preview branch "XYZ", that runs for 30 hours, incurring Compute and Egress costs. Disk Size usage remains within the 8 GB included in the subscription plan, so no additional charges apply. + +| Line Item | Costs | +|--------------------------------|-----------| +| Pro Plan | $25 | +| | | +| Compute Hours Small Project 1 | $15 | +| Egress Project 1 | $7 | +| Disk Size Project 1 | $3 | +| | | +| Compute Hours Micro Branch XYZ | $0.4 | +| Egress Branch XYZ | $1 | +| Disk Size Branch XYZ | $0 | +| | | +| **Subtotal** | **$51.4** | +| Compute Credits | -$10 | +| **Total** | **$41.4** | + +## View Branching usage +You can view Branching usage on the [organization's usage page](https://supabase.com/dashboard/org/_/usage). The page shows the usage of all projects by default. To view the usage for a specific project, select it from the dropdown. You can also select a different time period. +Usage page navigation bar + +In the Usage Summary section, you can see how many hours your Preview branches existed during the selected time period. Hover over "Branches Compute Hours" for a detailed breakdown. +Usage summary Branches Compute Hours + +## Optimize Branching usage +- merge Preview branches as soon as they are ready +- delete Preview branches that are no longer in use +- check whether your [persistent branches](/docs/guides/deployment/branching#persistent-branches) need to be defined as persistent, or if they can be ephemeral instead. Persistent branches will remain active even after the underlying PR is closed. + +## Branching FAQ +### Do Compute Credits apply to Branching Compute? +No, Compute Credits do not apply to Branching Compute. \ No newline at end of file diff --git a/apps/docs/public/img/guides/platform/usage-summary-branch-hours--dark.png b/apps/docs/public/img/guides/platform/usage-summary-branch-hours--dark.png new file mode 100644 index 00000000000..87fcf3d4964 Binary files /dev/null and b/apps/docs/public/img/guides/platform/usage-summary-branch-hours--dark.png differ diff --git a/apps/docs/public/img/guides/platform/usage-summary-branch-hours--light.png b/apps/docs/public/img/guides/platform/usage-summary-branch-hours--light.png new file mode 100644 index 00000000000..5708259f445 Binary files /dev/null and b/apps/docs/public/img/guides/platform/usage-summary-branch-hours--light.png differ diff --git a/supa-mdx-lint/Rule001HeadingCase.toml b/supa-mdx-lint/Rule001HeadingCase.toml index 283fb680c22..a2e309f2a34 100644 --- a/supa-mdx-lint/Rule001HeadingCase.toml +++ b/supa-mdx-lint/Rule001HeadingCase.toml @@ -21,6 +21,7 @@ may_uppercase = [ "Bitbucket", "Bitbucket Pipelines", "Boolean", + "Branching", "Broadcast", "CAPTCHA", "Channel",