https://github.com/bdougie/octoherd-script-validate-contribution

octoherd-script-good-pr
https://github.com/bdougie/octoherd-script-validate-contribution

octoherd-script

Last synced: 11 days ago
JSON representation

octoherd-script-good-pr

• Host: GitHub
• URL: https://github.com/bdougie/octoherd-script-validate-contribution
• Owner: bdougie
• License: mit
• Created: 2021-05-07T04:50:45.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-10T21:34:17.000Z (almost 3 years ago)
• Last Synced: 2024-10-17T02:41:30.527Z (22 days ago)
• Topics: octoherd-script
• Language: JavaScript
• Size: 76.2 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-octoherd-scripts - Validate contribution - Validate contributions. (Scripts)

README

        
# octoherd-script-validate-contribution

> octoherd-script-validate-contribution

[![@latest](https://img.shields.io/npm/v/.svg)](https://www.npmjs.com/package/octoherd-script-validate-contribution)

[![Build Status](https://github.com/bdougie/octoherd-script-validate-contribution/workflows/Test/badge.svg)](https://github.com/bdougie/octoherd-script-validate-contribution/actions?query=workflow%3ATest+branch%3Amain)

## Usage

Minimal usage

```js

npx octoherd-script-validate-contribution;

```

Pass all options as CLI flags to avoid user prompts

```js

npx octoherd-script-validate-contribution\

  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \

  -R "open-sauced/*"

```

## Options

| option                       | type             | description                                                                                                                                                                                                                                 |

| ---------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| `--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                                                                                                                                                                                                 |

| `--label`                    | string           | Label to apply to issues/pull-requests (default: `needs info`)                                                                                                                                                                              |

| `--text`                     | string           | Forbidden text (default: `TODO`) to mark issues/pull-requests with label                                                                                                                                                                    |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## About Octoherd

[@octoherd](https://github.com/octoherd/) is project to help you keep your GitHub repositories in line.

## License

[ISC](LICENSE.md)