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,217,186 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

70.4

Supply Chain

88.8

Quality

70.4

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

Contributors

Unable to fetch Contributors

View all 15 contributors

Languages

JavaScript

JavaScript (100%)

Developer

shinnn

Download Statistics

Total Downloads

3,217,186

Last Day

656

Last Week

3,271

Last Month

14,573

Last Year

234,312

GitHub Statistics

605 Stars

149 Commits

68 Forks

12 Watching

1 Branches

15 Contributors

Bundle Size

286.77 kB

Minified

84.78 kB

Minified + Gzipped

Bundlephobia

Maintainers

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

Publised On

20 Oct 2015

Total Downloads

Cumulative downloads

Total Downloads

3,217,186

Last day

7.7%

656

Compared to previous day

Last week

-10.2%

3,271

Compared to previous week

Last month

-0.9%

14,573

Compared to previous month

Last year

-34.2%

234,312

Compared to previous year

Daily Downloads

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

Versions

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

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

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.

Score

1.7

/10

Last Scanned on 2025-01-27

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

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