GitHub - octokit/create-octokit-project.js: "npm init" script to create a new Octokit JS module (original) (raw)

Skip to content

Navigation Menu

• • GitHub Copilot Write better code with AI
  • GitHub Advanced Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less
• Explore
  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights
• • GitHub Sponsors Fund open source developers
  • The ReadME Project GitHub community articles
• • Enterprise platform AI-powered developer platform
• Pricing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

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

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