Question 1

How do I set up a dry run with gulp-gh-pages?

Accepted Answer

Set the `push` option to `false` in the plugin configuration, which stages the deployment without pushing to the remote branch. This is useful for verifying files before live deployment, as documented in the API section.

Question 2

gulp-gh-pages or the gh-pages npm package, which should I use?

Accepted Answer

gulp-gh-pages is best if you're already using Gulp for builds, as it integrates natively. The gh-pages package is more generic and works with any Node.js script, but lacks Gulp's stream-based automation. Choose based on your build tool preference.

Question 3

Can I deploy only a subfolder to GitHub Pages with gulp-gh-pages?

Accepted Answer

Yes, adjust the source path in your Gulp task, e.g., `src('./dist/subfolder/**/*')`. The plugin pipes all provided files to the gh-pages branch, so ensure your Gulp pipeline outputs the correct directory.

Question 4

How to handle Git authentication for gulp-gh-pages in CI/CD?

Accepted Answer

Authentication relies on Git credentials set up in the environment, such as SSH keys or personal access tokens. The plugin uses the default Git remote, so configure credentials in your CI system (e.g., GitHub Secrets) for automated pushes.

Question 5

What happens if the deployment fails with gulp-gh-pages?

Accepted Answer

The plugin may throw errors, but the README doesn't specify recovery steps. You'd need to handle failures manually in your Gulp task or rely on external CI/CD tools for retries and logging, which can be a limitation.

Question 6

How to exclude certain files from being deployed?

Accepted Answer

Use Gulp's filtering capabilities, like `gulp-filter`, in your pipeline before piping to gulp-gh-pages. The plugin itself doesn't provide exclusion options beyond Git ignore rules, unless overridden with `force`.

gulp-gh-pages

What is gulp-gh-pages?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions