-
Notifications
You must be signed in to change notification settings - Fork 33
Unit test gen docs #398
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
Merged
Unit test gen docs #398
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d4b560b
thinky
73a8f48
thinky
f6ac900
lets not lmao
4aed002
thingy
00fa1d3
reference
0bbfe70
let them ask the question
8a2ec50
Merge branch 'main' into howon/utg
382228e
thinky
3bc7d0d
looks weird otherwise
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: Generate unit tests | ||
description: Automated Unit Test Generation with CodeRabbit | ||
--- | ||
|
||
```mdx-code-block | ||
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; | ||
|
||
<ProPlanNotice /> | ||
``` | ||
|
||
:::warning | ||
This feature is [experimental](/early-access#experiments). | ||
::: | ||
|
||
# Unit Test Generation | ||
|
||
Unit Test Generation is part of the [finishing touches](/future-development#finishing-touches). | ||
|
||
Unit Test Generation is an Early Access Experimental feature. | ||
|
||
## Usage | ||
|
||
Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding unit tests. You can request CodeRabbit to generate unit tests by typing `@coderabbitai auto-generate unit tests` in a comment under that pull request or by clicking a checkbox under **Generate Unit Tests** in the CodeRabbit Walkthrough. | ||
|
||
Once sent, CodeRabbit will perform the following actions: | ||
|
||
- The CodeRabbit agent will examine your code for places where it needs tests | ||
- Unit tests will be generated for the PR, in a separate PR, in the same PR in a new commit, or in a comment to copy-paste, depending on your choice | ||
- If (and only if) you choose to generate the unit tests in a separate PR, CodeRabbit will examine your GitHub checks (build steps and tests and such) and adjust the PR to deal with build failures, test failures and similar. | ||
|
||
## Path Instructions | ||
|
||
You can customize the generated unit tests by providing instructions based on file paths in your `.coderabbit.yaml`. The `path` is a [minimatch](https://github.com/isaacs/minimatch) pattern. | ||
|
||
```yaml | ||
code_generation: | ||
unit_tests: | ||
path_instructions: | ||
- path: "**/*.ts" | ||
instructions: | | ||
Use vitest for testing framework. | ||
Generate comprehensive test cases including edge cases and error conditions. | ||
Do not omit the imports; the test file must be valid. | ||
``` | ||
|
||
## Supported software forges | ||
|
||
These software forges are supported: | ||
howonlee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- GitHub | ||
|
||
## Supported CI/CD systems | ||
|
||
These CI/CD systems are supported for post-generation adjustments: | ||
|
||
- GitHub actions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.