1.1.0 • Published 2 years ago

octoherd-script-create-pr-templates v1.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

octoherd-script-create-pr-templates

Creates PRs to add issue templates across repositories

@latest Build Status

Usage

Create a pull_request_template.md with your own PR template content. Then run the following using the --templateDirectory parameter to source your local template file(s).

Minimal usage

npx octoherd-script-create-pr-templates \
  --octoherd-repos nickfloyd/octokat octokit/octokit.net \
  --templateDirectory $(pwd)/templates

Pass all options as CLI flags to avoid user prompts

npx octoherd-script-create-pr-templates \
  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
  -R "nickfloyd/*" \
  --octoherd-repos nickfloyd/octokat octokit/octokit.net \
  --templateDirectory $(pwd)/templates

NOTE: This script assumes the standard "hidden" directory structure in the target repo(s) - i.e. .github/ as defined here

Options

optiontypedescription
--template-directorystringRequired. The location of the template directory on a local instance
--label-namestringOptional. The name of the label that should be added to the PR instance
--octoherd-token, -TstringA personal access token (create). Script will create one if option is not set
--octoherd-repos, -Rarray of stringsOne 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-confirmsbooleanBypass prompts to confirm mutating requests

Contributing

See CONTRIBUTING.md

About Octoherd

@octoherd is project to help you keep your GitHub repositories in line.

License

ISC