Git Product home page Git Product logo

gh-pages-auto-release's Introduction

gh-pages-auto-release

This node module will help you to publish your package to dist folder as a github page.

All you have to do is run gh-pages-auto-release in your release script

{
  "name": "package-name",
  "version": "1.0.0",
  "scripts": {
    "build": ":", 
    "test": ":",
    "release": "gh-pages-auto-release",
  },
  "devDependencies": {
    "gh-pages-auto-release": "*"
  }
}

The --git-repo option

By default pages output of your project is pushed to a branch on its own repository (designated by the GIT_REMOTE_URL environment variable). You can change this by pointing to a different repository using the --git-repo option.

For example: gh-pages-auto-release --git-repo [email protected]:wix/my-library-gh-pages

This option is typically used on monorepos that have multiple projects with gh pages. Since github design dictates one-to-one relationship between published pages and the git repository, you should create a separate repository for publishing and pass it using this option.

Your page is automatically re-published every CI build

Once you're build is complete in CI, your page can be accessed at:

https://wix.github.io/package-name/

where package-name is the name you gave your git repository

obvious note: This url will work only if you have dist/index.html file generated by your build.

gh-pages-auto-release's People

Contributors

david-pe avatar felixmosh avatar shahata avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.