<hr>
<p><strong>Note</strong>: There are a lot of ways to do this, I'm only documenting the approach
I chose. For instance, I'm using the master branch and <code>docs/</code>, but you can use
another branch too.</p>
<hr>
<h1 id="initial-setup">Initial Setup</h1>
<h2 id="cname-file">CNAME file</h2>
<p>Pick a domain name. When I was writing this post, I was setting up the GitHub
Pages site for <a href="http://bwdt.breqwatr.com">Breqwatr Deployment Tool</a>, so I used
<code>bwdt.breqwatr.com</code>.</p>
<p>Create a file in your project's master branch named <code>docs/CNAME</code>, and put your
desired FQDN in that file. Push it to master.</p>
<h2 id="cname-dns-entry">CNAME DNS Entry</h2>
<p>I'm using CloudFlare, so I logged in there and made a new CNAME entry pointing
<code>bwdt.breqwatr.com</code> to <code>breqwatr.github.io</code>.</p>
<h2 id="repository-setup">Repository Setup</h2>
<p>As the repository owner, open the repo up in GitHub and go to the Settings
page. Look for the GitHub Pages option.</p>
<ul>
<li>Set your source to <code>master branch /docs folder</code>.</li>
<li>Choose a theme</li>
<li>Confirm custom domain in the "custom domain" field</li>
</ul>
<hr>
<h1 id="write-the-config-file">Write the config file</h1>
<p>Pull the changes GitHub made to your registry, then edit <code>docs/_config.yml</code>.</p>
<p>Give your page a title and description.</p>
<pre><code class="language-yaml">theme: jekyll-theme-slate
title: Breqwatr Deployment Tool
description: A private cloud deployment and management toolkit
</code></pre>
<hr>
<h1 id="write-content">Write Content</h1>
<p>Create a file named <code>docs/index.md</code> and write your page content here.</p>
<p>GitHub Pages will link this <code>index.md</code> file to the <code>/</code> path of your chosen
domain.</p>
<p>The content is written in Markdown, which is really intuitive and carries over
nicely from any <code>README.md</code> files you'll have written before.</p>
<h2 id="sub-pages">Sub-pages</h2>
<p>GitHub Pages supports breaking your content up into more than one static page.
Create a new content file such as <code>installation.md</code>, and GitHub Pages will
host it with a slug of <code>/installation</code>.</p>
<p>From the index file, link to your new secondary file using Markdown. Here's an
example of linking to an installation guide from a table of contents list.</p>
<pre><code class="language-text">Table of contents

- [Installation](/installation.html)
</code></pre>


<p><strong>This is a Reference Page:</strong> Reference pages are collections of short bits
of information that are useful to look up but not long or interesting enough to
justify having their own dedicated post.</p>
<p>This page covers how to do some things in Git.</p>
<hr>
<h3 id="table-of-contents">Table of Contents</h3>
<ul>
<li><a href="#use-vim-for-commits">Use Vim for commits</a></li>
<li><a href="#rename-branch">Rename Branch</a></li>
<li><a href="#roll-back-merge">Roll Back Merge</a>
<ul>
<li><a href="#option-1-abort-the-merge">Option 1: Abort the merge</a></li>
<li><a href="#option-2-reset-to-the-last-commit">Option 2: Reset to the last commit</a></li>
</ul>
</li>
<li><a href="#delete-a-file-from-git-history">Delete a File From Git History</a>
<ul>
<li><a href="#if-you-dont-push-with---force">If you don't push with --force</a></li>
</ul>
</li>
</ul>
<h1 id="use-vim-for-commits">Use Vim for commits</h1>
<p>Ugh, Nano. Kidding, but seriously here's how to use Vim instead.</p>
<pre><code class="language-bash">git config --global core.editor "vim"
</code></pre>
<hr>
<h1 id="rename-branch">Rename Branch</h1>
<pre><code class="language-bash"># Check out the branch to rename
git checkout development
# Rename the branch
git branch -m master
# Push the change
git push origin :development master
</code></pre>
<p>If you're using BitBucket and it fails to delete the branch, it might be set
as your MAIN branch. You need to change that before it can be deleted. You can
change it in the settings page.</p>
<hr>
<h1 id="roll-back-merge">Roll Back Merge</h1>
<p>If you do a git merge and its really ugly, you might want to undo that.</p>
<p>First you did the commit</p>
<pre><code class="language-bash">git checkout master
git merge --squash development
</code></pre>
<p>Then you got a TON of <code>CONFLICT</code> messages and a really dirty state.</p>
<h2 id="option-1-abort-the-merge">Option 1: Abort the merge</h2>
<p>This one's my preference. There might be a few <code>~</code> files left over to <code>rm</code>
manually.</p>
<pre><code class="language-bash">git merge --abort
</code></pre>
<h2 id="option-2-reset-to-the-last-commit">Option 2: Reset to the last commit</h2>
<p>First, get the commit right before this one from git log</p>
<pre><code class="language-bash">git log -n 1
</code></pre>
<p>Copy the commit hash</p>
<pre><code class="language-bash">git reset --hard &#x3C;commit hash>
</code></pre>
<p>You may need to clean up some files after that.</p>
<p><strong>extra</strong>
Usually, the next thing you wanna do is try the merge again with
<code>--stattheirs</code>, or</p>
<pre><code class="language-bash">git merge --squash --strategy-option=theirs development
</code></pre>
<hr>
<h1 id="delete-a-file-from-git-history">Delete a File From Git History</h1>
<p>It's important to note, as GitHub highlights <a href="https://help.github.com/en/articles/removing-sensitive-data-from-a-repository">in their documentation</a>,
if you've uploaded a secret password or something, you still need to change it.</p>
<p>The file I removed was called <code>sqldata.json</code>, and it was in my project root.
From the project root, I ran:</p>
<pre><code class="language-bash">git filter-branch --force --index-filter \
  "git rm --cached --ignore-unmatch sqldata.json" \
  --prune-empty --tag-name-filter cat -- --all

git push origin --force --all
</code></pre>
<h2 id="if-you-dont-push-with---force">If you don't push with --force</h2>
<p>When I tried to push, though, I got an error. I'd forgotten to use <code>--force</code>.</p>
<pre><code class="language-bash">To https://github.com/kylep/jsc2f.git
 ! [rejected]        master -> master (non-fast-forward)
 error: failed to push some refs to 'https://github.com/kylep/jsc2f.git'
 hint: Updates were rejected because the tip of your current branch is behind
 hint: its remote counterpart. Integrate the remote changes (e.g.
 hint: 'git pull ...') before pushing again.
 hint: See the 'Note about fast-forwards' in 'git push --help' for details.
</code></pre>
<p>Then, when I tried to pull, I got</p>
<pre><code class="language-bash">From https://github.com/kylep/jsc2f
 + ca7d7cc...710d37b master     -> origin/master  (forced update)
 fatal: refusing to merge unrelated histories
</code></pre>
<p>If you're getting errors like that, maybe you need to run push with <code>--force</code>.</p>
<pre><code class="language-bash">git push origin --force --all
</code></pre>


Kyle Pericak

Github Pages: Basics

Git Reference Page