Skip to content

octokit/create-octokit-project.js

Repository files navigation

Create new Octokit JS project

"npm init" script to create a new folder and repository for an Octokit JavaScript module (plugin, authentication strategy, or otherwise)

Usage

npm init octokit-project

What it does

  • Creates a new folder on your machine
  • Inits git in the new folder
  • Add LICENSE, CODE_OF_CONDUCT.md and README.md files
  • Creates a repository
  • Adds repository as git remote add origin <url>
  • Push the 3 files to main
  • Creates a new local branch called initial-version
  • Creates a package.json and package-lock.json. Installs dev dependencies.
  • Creates .gitignore, tsconfig.json
  • Creates test/smoke.test.ts
  • Creates actions for tests and automated releases
  • Creates a pull request with further instructions
  • Adds branch protection

Contribute

Pull requests welcome! My longer term goal is to make this script useful for Octokit Plugin developers.

License

MIT

About

"npm init" script to create a new Octokit JS module

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 15

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy