A simple script to deploy your GitHub project's main branch to GitHub pages.
See this package in action here.
npm install --save-dev deploy-gh
This script makes a best effort attempt to pick out your GitHub project's main
branch (this prefers main if that branch exists, otherwise it falls back to
master). Then it merges this into the gh-pages branch and pushes this back
to the remote origin.
First, make sure you have an index.html file in the root of your repository.
Next, inside package.json:
"scripts": {
"test": "... whatever you normally have here ...",
"deploy": "deploy-gh"
},
To run this, make sure all changes are committed on your main branch and then
run npm run deploy.
FAQs
A simple script to deploy main branch to GitHub pages
The npm package deploy-gh receives a total of 6 weekly downloads. As such, deploy-gh popularity was classified as not popular.
We found that deploy-gh demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.