Skip to content

Commit

Permalink
feat: all --octoherd-* flags are now optional (#6)
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 committed Apr 19, 2021
1 parent add5c46 commit e32fbb3
Show file tree
Hide file tree
Showing 3 changed files with 292 additions and 1,231 deletions.
24 changes: 21 additions & 3 deletions README.md
Expand Up @@ -4,14 +4,32 @@
## Usage

Minimal usage

```
npx @octoherd/script-star-or-unstar \
--octoherd-token 0123456789012345678901234567890123456789 \
"octoherd/*"
$ npx @octoherd/script-star-or-unstar \
--path-to-folders "scripts"
```

Pass all options as CLI flags to avoid user prompts

```
$ npx @octoherd/script-star-or-unstar \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "octoherd/repository-with-script-folders"
```

Add `--unstar` flag to unstar.

## Options

| option | type | description |
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--unstar` | boolean | Set to remove a star instead of adding one. |
| `--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 |

## License

[ISC](LICENSE.md)

0 comments on commit e32fbb3

Please sign in to comment.