Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update gift dependency #117

Merged
merged 1 commit into from
Jul 13, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .editorconfig
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ root = true
[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 2
indent_style = tab
tab_width = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.{md,yml}]
indent_style = space

[*.md]
trim_trailing_whitespace = false
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
*.txt
.nyc_output
coverage
node_modules
temp
16 changes: 4 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
sudo: false
git:
depth: 1
language: node_js
node_js: stable
node_js: node
before_script:
- git config --global user.name "John Doe"
- git config --global user.email [email protected]
script:
- npm run-script pretest
- npm run-script coverage
after_script:
- npm install istanbul-coveralls
- node node_modules/.bin/istanbul-coveralls
- git config --global user.email [email protected]
after_script: node_modules/.bin/nyc report --reporter=text-lcov | npx coveralls
env:
global:
secure: Fv8nNp9Gwmcr/h8emqdgYLgfO4lV+9FSZFL4Bw+lMbi7kzRsDAsfBdCTbKT+b9P/Q/JnEphX+5mXuo34plCvjwkRWxP/8G+Y89O+VA9GfNOZIUeTBnFo3U4ClhcZdo/Lz1MpCue7gcZit1FQKN9iIJFbLFtcC1ngAGtx76wqnT0=
secure: AyV0RreeMm/z1BIjjlTw3I7f/sbNblMfEoTabC41FTDK3i7GvJYsgqS9N38ACNKmB7i89mUr+GzKsXY3FoD7k6DGlSbjM9jYi6O2nEwa3/Q3RUVAXFJLQhr/IxlAsAv0Cp4jY6g7cA6qbVv0vbTUfnnC+0xoFl61EeEE3uv8uzE=
41 changes: 17 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# gulp-gh-pages

[![NPM version](http://img.shields.io/npm/v/gulp-gh-pages.svg)](https://www.npmjs.com/package/gulp-gh-pages)
[![npm version](https://img.shields.io/npm/v/gulp-gh-pages.svg)](https://www.npmjs.com/package/gulp-gh-pages)
[![Build Status](https://travis-ci.org/shinnn/gulp-gh-pages.svg?branch=master)](https://travis-ci.org/shinnn/gulp-gh-pages)
[![Build status](https://ci.appveyor.com/api/projects/status/iskj8sml9luhkm21?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/gulp-gh-pages)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/gulp-gh-pages.svg)](https://coveralls.io/r/shinnn/gulp-gh-pages)
[![Dependency Status](https://img.shields.io/david/shinnn/gulp-gh-pages.svg?label=deps)](https://david-dm.org/shinnn/gulp-gh-pages)
[![devDependency Status](https://img.shields.io/david/dev/shinnn/gulp-gh-pages.svg?label=devDeps)](https://david-dm.org/shinnn/gulp-gh-pages#info=devDependencies)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/gulp-gh-pages.svg)](https://coveralls.io/github/shinnn/gulp-gh-pages)

[gulp](http://gulpjs.com/) plugin to publish contents to [Github pages](https://pages.github.com/)

## Installation

[Use npm](https://docs.npmjs.com/cli/install).
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).

```sh
```
npm install --save-dev gulp-gh-pages
```

Expand All @@ -22,70 +20,67 @@ npm install --save-dev gulp-gh-pages
Define a `deploy` task in your `gulpfile.js` (as below) which can be used to push to `gh-pages` going forward.

```javascript
var gulp = require('gulp');
var ghPages = require('gulp-gh-pages');
const gulp = require('gulp');
const ghPages = require('gulp-gh-pages');

gulp.task('deploy', function() {
return gulp.src('./dist/**/*')
.pipe(ghPages());
});
gulp.task('deploy', () => gulp.src('./dist/**/*').pipe(ghPages()));
```

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

```she
```
gulp deploy
```

## API

```javascript
var ghPages = require('gulp-gh-pages');
const ghPages = require('gulp-gh-pages');
```

### ghPages([*options*])

*options*: `Object`
Return: `Object` ([stream.Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform_1))
Return: [`stream.Transform`](https://nodejs.org/api/stream.html#stream_class_stream_transform)

#### options.remoteUrl

Type: `String`
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`
Type: `string`
Default: `"origin"`

Git remote.

#### options.branch

Type: `String`
Type: `string`
Default: `"gh-pages"`

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

#### options.cacheDir

Type: `String`
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`
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`
Type: `boolean`
Default: `false`

Force adding files to the `gh-pages` branch, even if they are ignored by `.gitignore` or `.gitignore_global`.
Expand All @@ -99,6 +94,4 @@ Edit commit message.

## License

Copyright (c) 2014 [Micheal Benedict](https://github.com/rowoot), 2015 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).
[MIT License](./LICENSE) © 2014 [Micheal Benedict](https://github.com/rowoot), 2015 - 2018 [Shinnosuke Watanabe](https://github.com/shinnn)
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ build: off
before_test:
- git config --global user.name "John Doe"
- git config --global user.email [email protected]
test_script: npm run-script test-only
test_script: npx mocha test.js --timeout 50000 --full-trace
Loading