Skip to content

Commit

Permalink
feat: all --octoherd-* flags are now optional (#4)
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 <[email protected]>
  • Loading branch information
octoherd[bot] and gr2m committed Apr 19, 2021
1 parent 6a9c166 commit 77aab26
Show file tree
Hide file tree
Showing 3 changed files with 290 additions and 1,231 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,29 @@
## Usage

Minimal usage

```
$ npx @octoherd/script-find-releases
```

Pass all options as CLI flags to avoid user prompts

```
$ npx @octoherd/script-find-releases \
--octoherd-token 0123456789012345678901234567890123456789 \
"octoherd/*"
--since "2020-02-02" \
-T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
-R "octoherd/repository-with-script-folders"
```

Optionally add a `--since` flag to ignore releases before a defined date, e.g. `--since 2020-02-02`
## Options

| option | type | description |
| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--since` | string | Ignore releases before a specific date. Example: `--since 2020-02-02` |
| `--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

Expand Down
Loading

0 comments on commit 77aab26

Please sign in to comment.