Skip to content

Commit 317eaf6

Browse files
committed
Improve readme
1 parent 8ea50a7 commit 317eaf6

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

scripts/reporter/duplicate/README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,31 @@ This script helps remove duplicate issues from a GitHub repository by closing is
77
1. Set up environment variables:
88
- Create a `.env` file in the root directory
99
- Add the GitHub personal access token of the bot that manages issues on your collection, with `repo` permissions:
10-
```
11-
OTA_ENGINE_GITHUB_TOKEN=your_github_token
12-
```
13-
14-
2. Configure the target repository in `config/development.json`:
15-
```json
16-
{
17-
"@opentermsarchive/engine": {
18-
"reporter": {
19-
"githubIssues": {
20-
"repositories": {
21-
"declarations": "owner/repository"
22-
}
23-
}
24-
}
25-
}
26-
}
27-
```
10+
11+
```shell
12+
OTA_ENGINE_GITHUB_TOKEN=your_github_token
13+
```
14+
15+
2. Configure the target repository in your chosen configuration file within the `config` folder:
16+
17+
```json
18+
{
19+
"@opentermsarchive/engine": {
20+
"reporter": {
21+
"githubIssues": {
22+
"repositories": {
23+
"declarations": "owner/repository"
24+
}
25+
}
26+
}
27+
}
28+
}
29+
```
2830

2931
## Usage
3032

3133
Run the script using:
3234

33-
```
35+
```shell
3436
node scripts/reporter/duplicate/index.js
3537
```

0 commit comments

Comments
 (0)