Skip to content

Commit 77aab26

Browse files
octoherd[bot]gr2m
andauthored
feat: all --octoherd-* flags are now optional (#4)
BREAKING CHANGE: Repositories can no longer be passed as positional argument, use the `--octoherd-repos` (or `-R`) CLI flag instead. Before: ``` npx @octoherd/script-add-octoherd-cli-to-script "@octokit/*" ``` After ``` npx @octoherd/script-add-octoherd-cli-to-script --octoherd-repos "@octokit/*" ``` Or do not set `--octoherd-repos` at all, in which case the user will be prompted. Co-authored-by: Gregor Martynus <[email protected]>
1 parent 6a9c166 commit 77aab26

File tree

3 files changed

+290
-1231
lines changed

3 files changed

+290
-1231
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,29 @@
44
55
## Usage
66

7+
Minimal usage
8+
9+
```
10+
$ npx @octoherd/script-find-releases
11+
```
12+
13+
Pass all options as CLI flags to avoid user prompts
14+
715
```
816
$ npx @octoherd/script-find-releases \
9-
--octoherd-token 0123456789012345678901234567890123456789 \
10-
"octoherd/*"
17+
--since "2020-02-02" \
18+
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
19+
-R "octoherd/repository-with-script-folders"
1120
```
1221

13-
Optionally add a `--since` flag to ignore releases before a defined date, e.g. `--since 2020-02-02`
22+
## Options
23+
24+
| option | type | description |
25+
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| `--since` | string | Ignore releases before a specific date. Example: `--since 2020-02-02` |
27+
| `--octoherd-token`, `-T` | string | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set |
28+
| `--octoherd-repos`, `-R` | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |
29+
| `--octoherd-bypass-confirms` | boolean | Bypass prompts to confirm mutating requests |
1430

1531
## License
1632

0 commit comments

Comments
 (0)