npmpackage.info

Gathering detailed insights and metrics for gulp-gh-pages

Other packages similar to gulp-gh-pages

@types/gulp-gh-pages

0.0.37

TypeScript definitions for gulp-gh-pages

@justeat/gulp-gh-pages

1.0.3

Gulp v3 plugin to publish contents to Github pages

gulp-gh-pages-ci-compatible

1.0.0

Gulp plugin to publish to Github pages (gh-pages branch).

gulp-gh-pages-latest

0.6.0-6

gulp plugin to publish contents to Github pages

Gathering detailed insights and metrics for gulp-gh-pages

gulp-gh-pages - 0.5.4 | npmpackage.info

gulp-gh-pages

A gulp 4 plugin to publish contents to Github pages

0.5.4

605

NOASSERTION

JavaScript

84.78 kB

3,291,122 1.7

Installations

npm install gulp-gh-pages

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

4.2.1

NPM Version

3.3.8 Score

69.7

Supply Chain

88.8

Quality

70.3

Maintenance

Vulnerability

97.1

License

Pull Requests

Open

1

Total

36

Closed

11

Merged

24

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

shinnn

Download Statistics

Total Downloads

3,291,122

Last Day

343

Last Week

3,942

Last Month

16,756

Last Year

235,295

GitHub Statistics

NOASSERTION License

605 Stars

149 Commits

62 Forks

12 Watchers

1 Branches

15 Contributors

Updated on Jul 01, 2025

Bundle Size

286.77 kB

Minified

84.78 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 15 Contributors

Package Meta Information

Latest Version

0.5.4

Package Id

gulp-gh-pages@0.5.4

Size

5.22 kB

NPM Version

3.3.8

Node Version

4.2.1

Published on

Oct 20, 2015

Total Downloads

Cumulative downloads

Total Downloads

3,291,122

Last Day

13.2%

343

Compared to previous day

Last Week

2.6%

3,942

Compared to previous week

Last Month

-14.3%

16,756

Compared to previous month

Last Year

-15.8%

235,295

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

gift gulp-util readable-stream rimraf vinyl-fs wrap-promise

Dev Dependencies

@shinnn/eslint-config-node-legacy eslint graceful-fs istanbul log-symbols mocha node-uuid octonode read-remove-file vinyl

gulp-gh-pages

gulp plugin to publish contents to Github pages

Installation

Use npm.

1npm install --save-dev gulp-gh-pages

Usage

Define a deploy task in your gulpfile.js (as below) which can be used to push to gh-pages going forward.

1var gulp = require('gulp');
2var ghPages = require('gulp-gh-pages');
3
4gulp.task('deploy', function() {
5  return gulp.src('./dist/**/*')
6    .pipe(ghPages());
7});

Now, you should be able to call your task by doing:

1gulp deploy

API

1var ghPages = require('gulp-gh-pages');

ghPages([options])

options: Object
Return: Object (stream.Transform)

options.remoteUrl

Type: String
Default: URL for the remote of the current dir (assumes a git repository)

By default gulp-gh-pages assumes the current working directory is a git repository and uses its remote url. If your gulpfile.js is not in a git repository, or if you want to push to a different remote url, you can specify it. Ensure you have write access to the repository.

options.origin

Type: String
Default: "origin"

Git remote.

options.branch

Type: String
Default: "gh-pages"

The branch where deploy will by done. Change to "master" for username.github.io projects.

options.cacheDir

Type: String
Default: .publish

Set the directory path to keep a cache of the repository. If it doesn't exist, gulp-gh-pages automatically create it.

options.push

Type: Boolean
Default: true

Allow you to make a build on the defined branch without pushing it to master. Useful for dry run.

options.force

Type: Boolean
Default: false

Force adding files to the gh-pages branch, even if they are ignored by .gitignore or .gitignore_global.

options.message

Type: String
Default: "Update [timestamp]"

Edit commit message.

License

Licensed under the MIT License.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

39 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More