Installations

npm install gulp-gh-pages-latest

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

12.12.0

NPM Version

6.12.0 Score

63.3

Supply Chain

92.1

Quality

68.3

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

1

Total

36

Closed

11

Merged

24

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

15

Unable to fetch Contributors

View all 15 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

shinnn

Download Statistics

Total Downloads

497

Last Day

1

Last Week

2

Last Month

5

Last Year

59

GitHub Statistics

605 Stars

149 Commits

68 Forks

12 Watching

1 Branches

15 Contributors

Bundle Size

206.91 kB

Minified

60.69 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

0.6.0-6

Package Id

gulp-gh-pages-latest@0.6.0-6

Unpacked Size

11.51 kB

Size

4.59 kB

File Count

5

NPM Version

6.12.0

Node Version

12.12.0

Total Downloads

Cumulative downloads

Total Downloads

497

Last day

0%

1

Compared to previous day

Last week

100%

2

Compared to previous week

Last month

66.7%

5

Compared to previous month

Last year

-29.8%

59

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

7

fancy-log gift inspect-with-kind plugin-error rimraf vinyl vinyl-fs

Dev Dependencies

9

@shinnn/eslint-config eslint load-gh-token lodash mocha nyc nyc-config-common octonode read-remove-file

Versions

gulp-gh-pages

gulp plugin to publish contents to Github pages

Installation

Use npm.

npm install --save-dev gulp@next 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.

1const {src, task}= require('gulp');
2const ghPages = require('gulp-gh-pages');
3
4task('deploy', () => src('./dist/**/*').pipe(ghPages()));

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

gulp deploy

API

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

ghPages([options])

options: Object
Return: 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 the URL of the remote designated by origin. 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.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

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.

Score

1.7

/10

Last Scanned on 2025-01-20

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