-
Notifications
You must be signed in to change notification settings - Fork 0
Automation (remediation) documentation #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
d885c62
3348b3b
3fb8473
56ce566
282ac6c
9e027b6
8f36460
8f6ba8b
4fa3830
f38857f
5cbdafe
effcee9
70cdaf0
6eeaedd
ba4f912
c50766a
fa8f40c
60fc525
1d6898c
e2a357e
405c7bf
f3e3c05
3b4df08
612f4f3
04ac9fd
2b5510f
1d36cf8
6add203
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,57 @@ | ||
| --- | ||
| title: "Trial and billing" | ||
| description: "Understand Code Review payment methods, trials, seats, and subscription lifecycle." | ||
| title: "Code Review Billing" | ||
| description: "Free trial, seats, spillover, and subscription lifecycle for Code Review." | ||
| --- | ||
|
|
||
| Code Review billing is based on Code Review seats. A seat covers one developer whose pull requests or merge requests can be reviewed by Hacktron. | ||
| Each developer with Code Review enabled counts as one seat. Seats can be assigned manually, or Hacktron can assign seats automatically when developers open pull requests in covered repositories. | ||
|
|
||
| Organization owners manage payment methods, invoices, billing details, subscription state, and promotion codes from **Billing**. | ||
| Code Review is billed as a monthly subscription. At the end of each billing period, your organization is charged for the number of seats that were active during that period. | ||
|
|
||
| ## Start a trial | ||
| <Info> | ||
| If a developer no longer needs Code Review, remove their seat from **People**. | ||
|
|
||
| The removed seat can be reassigned to someone else during the same billing period, but removing a seat in the middle of the billing period will not reduce the seat count for that period. | ||
| </Info> | ||
|
|
||
| Code Review has a free trial for new organizations. | ||
| ## Start your Free Trial | ||
|
|
||
| <Steps> | ||
| <Step title="Open Billing">Go to **Billing** as an organization owner.</Step> | ||
| <Step title="Start the trial"> | ||
| Review and accept the terms of service and start the trial. No payment method | ||
| is required during the free trial. | ||
| <Step title="Open Billing"> | ||
| Open Billing from the side bar. You must be an organization owner to see this. | ||
|
|
||
|  | ||
| </Step> | ||
| <Step title="Start the Code Review Trial"> | ||
| Review and accept the terms of service and start the trial. No payment method is required during the free trial. | ||
| </Step> | ||
| <Step title="Start the Code Review trial"> | ||
| Once the trial is active, Hacktron starts running code reviews on all | ||
| covered repositories. | ||
| <Step title="Done!"> | ||
| Once the trial is active, Hacktron starts running code reviews on all covered repositories. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## How seats are billed | ||
|
|
||
| Each developer with Code Review enabled counts as one Code Review seat. | ||
| Seats can be assigned manually, or Hacktron can assign seats automatically | ||
| when developers open pull requests in covered repositories. | ||
|
|
||
| Code Review is billed as a monthly subscription. At the end of each billing period, | ||
| your organization is charged for the number of Code Review seats that were active | ||
| during that period. | ||
| ## End Trial Early | ||
|
|
||
| <Info> | ||
| If a developer no longer needs Code Review, remove their seat from **People**. | ||
|
|
||
| The removed seat can be reassigned to someone else during the same billing period, | ||
| but removing a seat in the middle of the billing period will not reduce the | ||
| seat count for the current billing period. | ||
|
|
||
| </Info> | ||
|
|
||
| ## End a trial early | ||
|
|
||
| Ending the trial early allows you to start the paid plan immediately and enable [spillover usage](/code-review/spillover-usage). | ||
| Ending the trial early allows you to start the paid plan immediately and enable [**spillover usage**](https://docs.hacktron.ai/code-review/spillover-usage). | ||
|
|
||
| <Steps> | ||
| <Step title="Open Billing">Go to **Billing** as an organization owner.</Step> | ||
| <Step title="End the trial early"> | ||
| Go to **Billing** and end the trial early to start the paid plan immediately. | ||
|
|
||
| <img src="/images/end_early.png" alt="End trial early" /> | ||
|
|
||
| <Frame> | ||
|  | ||
| </Frame> | ||
| </Step> | ||
| <Step title="Enable spillover"> | ||
| Go to **Usage** to enable spillover billing to continue reviewing pull requests or merge requests | ||
| after the pooled review limit is reached. | ||
| Go to **Usage** to enable spillover billing to continue reviewing pull requests or merge requests after the pooled review limit is reached. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Cancellations and resubscription | ||
| ## Cancellations and resubscriptions | ||
|
|
||
| If you cancel during a trial or paid subscription, Code Review remains available | ||
| until the end of the current trial or billing period. After cancellation takes effect, | ||
| new pull requests or merge requests are no longer reviewed. | ||
| If you cancel during a trial or paid subscription, Code Review remains available until the end of the current trial or billing period. After cancellation takes effect, new pull requests or merge requests are no longer reviewed. | ||
|
|
||
| If the organization resubscribes later, Code Review starts as a paid subscription. | ||
| The free trial does not restart. | ||
| If the organization resubscribes later, Code Review starts as a paid subscription. The free trial does not restart. | ||
|
|
||
| <Card | ||
| title="Spillover and usage" | ||
| icon="chart-line" | ||
| href="/code-review/spillover-usage" | ||
| > | ||
| <Card title="Spillover and usage" icon="chart-line" href="/code-review/spillover-usage"> | ||
| Understand pooled review limits and overage pricing. | ||
| </Card> | ||
| </Card> |
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Delete this file - it's not used |
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Delete this file - it's not used |
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's update this to show a PR by |
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need to update screenshots once the new credits/billing page is pushed |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: "Automation credits" | ||
| description: "Understand how you buy automation credit, how each run deducts them, and how auto top-up keeps your balance stocked." | ||
| --- | ||
|
|
||
| [Automations](/platform/automations/overview) run on shared organization automation credits. Every [remediation](/platform/automations/remediation) run, whether triggered manually from a finding or by an automation, deducts credits based on what the run costs when it completes. | ||
|
|
||
| Automation credits are organization-wide. They are separate from Code Review seats and your Whitebox Scan credits. | ||
|
|
||
| ## How credits work | ||
|
|
||
| <Steps> | ||
| <Step title="Keep a balance"> | ||
| <Tip> | ||
| All organizations with an active [Code Review](/code-review/overview) subscription start with \$50 in automation credits. | ||
| </Tip> | ||
|
|
||
| Buy credits from **Billing** (access only for Organization Owners), and / or turn on auto top-up to keep the balance above a threshold you set. | ||
|
|
||
|  | ||
| </Step> | ||
| <Step title="Checkout"> | ||
| Complete any required card authentication (such as 3D Secure). The purchased credits are added to the organization balance after the charge succeeds. | ||
| </Step> | ||
| <Step title="Runs check the balance"> | ||
| A remediation run only starts while the organization has credits. When the balance runs out, new runs don't start and the Billing page shows that automations are paused. | ||
| </Step> | ||
| <Step title="Runs deduct on completion"> | ||
| Each run's cost is deducted from the balance once, when the run completes. Costs vary with the size of the run. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Auto top-up | ||
|
|
||
| Auto top-up buys credits automatically when the balance drops below a threshold, so your automations keep running without manual purchases. | ||
|
|
||
| Set it up on the Billing page under your automation credit balance: | ||
|
|
||
| - **Trigger**: the balance that starts a top-up. | ||
| - **Target**: the balance the top-up buys back up to. Your target must be above the trigger. | ||
| - **Monthly limit**: an optional cap on how many credits auto top-up may buy per month. | ||
|
|
||
| Auto top-up requires a saved payment method and charges the card on file without an interactive checkout. If a top-up charge fails, your automations stay paused until the balance is topped up manually or the card issue is resolved. | ||
|
|
||
| ## Related docs | ||
|
|
||
| <Columns cols={2}> | ||
| <Card title="Remediation" icon="wrench" href="/platform/automations/remediation"> | ||
| Trigger an AI-generated fix for a finding. | ||
| </Card> | ||
|
|
||
| <Card title="Automations" icon="bolt" href="/platform/automations/overview"> | ||
| Auto-remediate qualifying findings and notify your team. | ||
| </Card> | ||
| </Columns> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can revert changes in this file - we no longer look at the
.hacktron/config.yamlfile. Everything is configured through our app frontend now.