Skip to content

Commit

Permalink
feat: all --octoherd-* flags are now optional (#2)
Browse files Browse the repository at this point in the history
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 <39992+gr2m@users.noreply.github.com>
  • Loading branch information
octoherd[bot] and gr2m authored May 11, 2021
1 parent e63b7a6 commit e0e7e57
Show file tree
Hide file tree
Showing 3 changed files with 286 additions and 1,229 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,29 @@

## Usage

Minimal usage

```js
npx octoherd-script-watch-unwatch-or-ignore
```

Pass all options as CLI flags to avoid user prompts

```
npx octoherd-script-watch-unwatch-or-ignore \
--octoherd-token 0123456789012345678901234567890123456789 \
"oscard0m/*"
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "oscard0m/*"
```

Add `--ignore` flag to ignore notifications for selected repositories
## Options

Add `--unwatch` flag to unwatch selected repositories
| option | type | description |
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--unwatch` | string | Stop watching repository |
| `--ignore` | string | Ignore all notifications |
| `--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 |
| `--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 |
| `--octoherd-bypass-confirms` | boolean | Bypass prompts to confirm mutating requests |

## Contributing

Expand Down
Loading

0 comments on commit e0e7e57

Please sign in to comment.