actions/ai-codereviewer
2
0
Fork 0
mirror of https://github.com/freeedcom/ai-codereviewer.git synced 2025-04-22 10:36:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated doc

Browse source
This commit is contained in:
Jimmy Royer 2024-12-30 15:18:22 -05:00
parent d0abf2f802
commit 45d8bc1842
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/exportComments.ts
View file

@ -10,17 +10,17 @@
* *
* Options: * Options:
* --owner, -o Repository owner (required) * --owner, -o Repository owner (required)
* --repo, -r Repository name (required) * --repos, -r Repositories to search into (required)
* --author, -a Author of the comments to filter with (optional -- likely the AI bot author name) * --author, -a Author of the comments to filter with (optional -- likely the AI bot author name)
* --since, -s Filter comments since the given date (YYYY-MM-DD) (required) * --since, -s Filter comments since the given date (YYYY-MM-DD) (required)
* --until, -u Filter comments until the given date (YYYY-MM-DD) (optional, defaults to current date) * --until, -u Filter comments until the given date (YYYY-MM-DD) (optional, defaults to current date)
* --token, -t GitHub personal access token (can also be set via the GITHUB_TOKEN environment variable or `.env` file) * --token, -t GitHub personal access token (can also be set via the GITHUB_TOKEN environment variable or `.env` file)
* It is recommended to use the environment variable to avoid exposing sensitive information. * It is recommended to use the environment variable to avoid exposing sensitive information.
* *
* Example: * Examples:
* npx ts-node exportComments.ts --owner cds-snc --repo cds-ai-codereviewer --prs 6,7,8 --author github-actions[bot] * npx ts-node exportComments.ts --owner cds-snc --repos cds-ai-codereviewer --author 'github-actions[bot]' --since 2024-12-01
* *
* npx ts-node src/exportComments.ts --owner cds-snc --repo notification-terraform --since 2024-12-01 --author 'github-actions[bot]' --until 2024-12-31 * npx ts-node src/exportComments.ts --owner cds-snc --repos notification-terraform notification-api --author 'github-actions[bot]' --since 2024-12-01 --until 2024-12-31
* *
* Environment Variable: * Environment Variable:
* GITHUB_TOKEN GitHub personal access token (recommended to use this instead of --token argument) * GITHUB_TOKEN GitHub personal access token (recommended to use this instead of --token argument)