By the end of this, developers should be able to:
- Deploy a client application to GitHub Pages.
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>
- Deploy early and often.
- NEVER work on the
master
branch. - Merge
feature
branch ontomaster
when your feature is done. git push origin
every time you merge tomaster
.grunt deploy
every time you merge tomaster
.- Inspect your deployment in the browser.
- NEVER merge
gh-pages
intomaster
.
- After deploying your site, paste the URL into the
url.md
file and open a Pull Request.
-
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.
- All content is licensed under a CCBYNCSA 4.0 license.
- All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact [email protected].