Github Cookbook

Create the GIT branch on your local machine :

$ git checkout -b your_branch

Switched to a new branch ''

Push the branch on github :

$ git push origin your_branch

Total 0 (delta 0), reused 0 (delta 0)
To git@github.com:komli/autoatom.git
* [new branch] ->

You can see all branches created by using

Pulling all the changes to the branch/repo :

$ git pull

Committing changes to the branch :

$ git commit

Push changes from your commit into your branch :

$ git push origin your_branch

Commit diff between your branch & master :

$git log --pretty=format:'%C(yellow)%h%C(red)%d %C(red)|%C(green) %ad %C(red)| %Creset%s%Cblue [%cn]' --decorate --graph --date=short master..your_branch

Merging code from your branch to master:

$ git checkout master
$ git merge your_branch

Checking merge from your branch to master:

$ git checkout your_branch
$ git log --pretty=format:'%C(yellow)%h%C(red)%d %C(red)|%C(green) %ad %C(red)| %Creset%s%Cblue [%cn]' --decorate --graph --date=short master..your_branch

>> Here you should see 0 diff

Once you are sure the code is merged successfully, push changes from your commit into master:

$ git checkout master
$ git push origin master

Creating tag in master:

$ git checkout master
$ git tag -a tag_name -m 'Describe tag details here'

eg. git tag -a syncs_poc_1.0 -m 'Sync Server 1.0 PoC'

Verifying tag Created:

$ git tag -l

This should have the tag you have created

$ git tag -v tag_name

This should show up all the details

Pushing the tag to github:

$ git push origin tag_name

eg. git push origin syncs_poc_1.0

Counting objects: 1, done.
Writing objects: 100% (1/1), 183 bytes, done.
Total 1 (delta 0), reused 0 (delta 0)
To git@github.com:komli/autoatom.git
* [new tag] syncs_poc_1.0 -> syncs_poc_1.0

Generating SSH keys and Access to Github Repo from Machine

SSH keys are a way to identify trusted computers, without involving passwords. The steps below will walk you through generating an SSH key and then adding the public key to your GitHub Enterprise account.

Tip: We recommend that you regularly review your SSH keys list and revoke any that haven't been used in a while.

Step 1: Check for SSH keys

First, we need to check for existing SSH keys on your computer. Open up your Git Bash and type:

ls -al ~/.ssh
# Lists the files in your .ssh directory, if they exist

Check the directory listing to see if you already have a public SSH key. The default public key file names are:

• id_dsa.pub
• id_ecdsa.pub
• id_ed25519.pub
• id_rsa.pub

Step 2: Generate a new SSH key

To generate a new SSH key, copy and paste the text below, making sure to substitute in your email address. The default settings are preferred, so when you're prompted to "Enter a file in which to save the key", just press Enter to continue.

ssh-keygen -t rsa -C "your_email@example.com"
# Creates a new ssh key, using the provided email as a label
# Generating public/private rsa key pair.
# Enter file in which to save the key (/c/Users/you/.ssh/id_rsa): [Press enter]

Next, you'll be asked to enter a passphrase.

Tip: We strongly recommend a very good, secure passphrase. For more information, see Working with SSH key passphrases.

# Enter passphrase (empty for no passphrase): [Type a passphrase]
# Enter same passphrase again: [Type passphrase again]

Which should give you something like this:

# Your identification has been saved in /c/Users/you/.ssh/id_rsa.
# Your public key has been saved in /c/Users/you/.ssh/id_rsa.pub.
# The key fingerprint is:
# 01:0f:f4:3b:ca:85:d6:17:a1:7d:f0:68:9d:f0:a2:db your_email@example.com

Then add your new key to the ssh-agent:

# start the ssh-agent in the background
ssh-agent -s
# Agent pid 59566
ssh-add ~/.ssh/id_rsa

Step 3: Add your SSH key to your account

Run the following command to copy the key to your clipboard. Keep in mind that your key may also be named id_dsa.pub, id_ecdsa.pub or id_ed25519.pub.

clip < ~/.ssh/id_rsa.pub
# Copies the contents of the id_rsa.pub file to your clipboard

Alternatively, using your favorite text editor, you can open the public key file and copy the contents of the file manually.

Now that you have the key copied, it's time to add it to GitHub Enterprise:

1. In the top right corner of any page, click .
2. In the user settings sidebar, click SSH keys.
3. Click Add SSH key.
4. In the Title field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".
5. Paste your key into the "Key" field.
6. Click Add key.
7. Confirm the action by entering your GitHub Enterprise password.

Step 4: Test everything out

To make sure everything is working, you'll now try SSHing to your GitHub Enterprise instance. When you do this, you will be asked to authenticate this action using your password, which was the passphrase you created earlier.

Open up your Git Bash and type:

ssh -T git@hostname
# Attempts to ssh to GitHub Enterprise

You may see this warning:

# The authenticity of host 'hostname (207.97.227.239)' can't be established.
# RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.
# Are you sure you want to continue connecting (yes/no)?

Don't worry! This is supposed to happen. Verify that the fingerprint in your terminal matches the one we've provided up above, and then type "yes."

# Hi username! You've successfully authenticated, but GitHub does not
# provide shell access.

If that username is yours, you've successfully set up your SSH key! Don't worry about the "shell access" thing, you don't want that anyway.

If you receive a message about "access denied," you can read these instructions for diagnosing the issue.

If you're switching from HTTPS to SSH, you'll now need to update your remote repository URLs. For more information, see Changing a remote's URL.