Giter Club home page Giter Club logo

gh-pages-deployment-guide's Introduction

General Assembly Logo

GitHub Pages Deployment Guide

Objectives

By the end of this, developers should be able to:

  • Deploy a client application to GitHub Pages.

Deployment Steps

If your work has been merged to a master branch, it is ready to be deployed.

From the master branch, and at the root of your project, run grunt deploy. If the working directory isn't clean, the deploy task will exit and show you the output of the git status command. To fix this, add and commit changes you wish to keep on the appropriate branch (most likely not master).

Go to the URL <your-username>.github.io/<repository-name> in your browser, you should be able to see your page! If you don't, be patient. Sometimes, it takes up to 15 minutes for GH Pages to display your deployed page.

As a general rule, the formula for a GitHub Pages URL is: <your-username>.github.io/<repository-name>/path-to-location-of-index.html>

Workflow Rules

  1. Deploy early and often.
  2. NEVER work on the master branch.
  3. Merge feature branch onto master when your feature is done.
  4. git push origin every time you merge to master.
  5. grunt deploy every time you merge to master.
  6. Inspect your deployment in the browser.
  7. NEVER merge gh-pages into master.

Deliverable

  • After deploying your site, paste the URL into the url.md file and open a Pull Request.

Deployment Commandments

  • gh-pages is not a replacement for grunt serve.

  • gh-pages is a production environment.

  • NEVER test code in production environments.

  • ONLY deploy when code is verified as working.

Additional Resources

  1. All content is licensed under a CC­BY­NC­SA 4.0 license.
  2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].

gh-pages-deployment-guide's People

Contributors

jordanallain avatar laurenfazah avatar jrhorn424 avatar bengitscode avatar

Watchers

James Cloos 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.