Skip to content

README.git.md

Latest commit

 

History

History
230 lines (150 loc) · 7.62 KB

README.git.md

File metadata and controls

230 lines (150 loc) · 7.62 KB

GIT

git is essential to our everyday operations when using version control.

  • Alias
  • Extensions
  • Managing Secrets for Git

GIT Aliases

matrix.dot.files includes many useful aliases to enhance your GIT experience.

Aliases

  • git aliases - List your aliases
  • git [br,ci,co,df,st] - Common git shortcut string aliases
  • git info - Show the remote configuration

Tracking

  • git diff-staged - Show the diff of staged files by using the cached flag
  • git wdiff - Show the diff with Color
  • git forget - Removes the copy of the file from the index / staging-area, without touching the working tree copy
  • git ignored - List files ignored by the repo

Backout

  • git revertfile - Recheckout a file
  • git uncommit - Reset and backout the lastcommit before a push

Destructive

  • git purge - remove untracked directories (permanently deletes files)
  • git squash-all - Squash the entire repo
  • git remove-tags - Remove all the tags

Stash Helpers

  • (git stash) - Builtin - Record the current state of the working directory and the index, but want to go back to a clean working directory.
  • git unstash - Pop from the Stash back on the checked out files

Stage Helpers

  • (git stage) - Builtin - (This is a synonym for git-add)
  • git staged - List what is staged
  • git unstage - Unstage a file that was staged

Skip Helpers

  • git skipped - List files that are ignored but in the repo
  • git skip - Ignore a local file changes in the repo (like a local config file that is actually in the repo)
  • git unskip - Stop ignoring local file changes in the repo

Generation

  • git markdown-toc - Create a markdown TOC

Log Aliases

Security

  • git leaks - Scan for secrets recursively in the local directory, not the repo itself using gitleaks.

Extensions

Git plugins in the shell $PATH slip into the main binary completion similiar to kubectl.

Swap Users

git swap - quickly change current git/github user in the repo

Example: Swap to user shadowbq in current checked out repo

$ git swap shadowbq
shadowbq <shadowbq@gmail.com>

Example Options:

usage: ./git swap <username in ~/.gitusers>
usage: ./git swap <username> <email>

Switch Local and Save to Config
usage: ./git swap [--new-user1 || -1] <username> <email>
usage: ./git swap [--new-user2 || -2] <username> <email>
usage: ./git swap [--new-user3 || -3] <username> <email>

Switch Global
usage: ./git swap [--global || -g] <username> <email>

The configuration supports three different users [user1,user2,user3]

~/.gitusers
user1name="shadowbq"
user1email="shadowbq@gmail.com"

Git Who Am I

git whoami - Show who you are based on global or local settings in a repo

$> git whoami
shadowbq <shadowbq@gmail.com>

Git Downcase

git downcase - Downcase all filenames in the current repo!

Note: The global MDF in ~/.gitconfig config is set to 'ignorecase'

Need I say more.. force downcase of filenames in repo. It will git mv the files to the new locations. It will also set the current repo configuration:

git config core.ignorecase false

Private Repos

git-private "${git_tag}" myorg private-repo "${filename}" "${archive:?}/${filename}" - Download a Published Private Tag from Github using Curl HTTPs REST API.

The wack-o-mole of fetching HTTPS git private repos.

Example usage:

 export GITHUB_TOKEN=ABCDEFGHIJ0123456789 
git private v0.0.1 myorg private-repo foo.tar.gz /var/tmp/foo.tar.gz

Example usage: less secure

GITHUB_TOKEN=ABCDEFGHIJ0123456789 git private v0.0.1 myorg private-repo foo.tar.gz /var/tmp/foo.tar.gz

Proxy Clear

git proxyclear - Nuke proxy settings

Clearing any proxy settings that may be attached to the current checked out repo.

Others

git md-toc-creator - Markdown Table of Contents Creations script.

Secrets

You should use MDF Secrets if you don't / can't use SSH as the git protocol. In 2021 they will obsolete the use of passwords in github for HTTPS access to git repositories.

README - Secrets - MDF Secrets with GPG and Bash

On a macOS:

Open KeyChain Access (Via spotlight search) → search GitHub → click GitHub → change and save with your new PAT link

matrix-screenshot

Password Obsolete -> Using the Personal Access Tokens

Warning: Tokens have read/write access and should be treated like passwords. If you enter your token into the clone URL when cloning or adding a remote, Git writes it to your .git/config file in plain text, which is a security risk.

$> git push
remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.
fatal: Authentication failed for 'https://github.com/shadowbq/matrix.dot.files.git/'

Remove old PW based origin, and convert to PAT. (Note: The space for not logging the history of the TOKEN)

git remote remove origin
 git remote add origin https://[USERNAME]:[NEW TOKEN]@github.com/[USERNAME]/[REPO].git
git push

Generating Personal access tokens

Create an admin:all Personal access token in Github.

admin:all — admin:enterprise, admin:gpg_key, admin:org, admin:org_hook, admin:public_key, admin:repo_hook, delete:packages, delete_repo, gist, notifications, repo, user, workflow, write:discussion, write:packages

Save it as MDF Secret and load it via the GPG key method into your shell. Tokens are not passwords that you can set, so using secure mechanism to input the token is very important.

Optional: Git Credential Manager Core

Investigate the current credential setting:

$> git config --show-origin --get credential.helper
file:/Users/smacgregor/.gitconfig	osxkeychain
$> git config --global credential.helper`

Unset if not wanted/needed.

git config --global --unset credential.helper

Git Credential Manager Core (GCM Core) is another way to store your credentials securely and connect to GitHub over HTTPS. With GCM Core, you don't have to manually create and store a PAT, as GCM Core manages authentication on your behalf, including 2FA (two-factor authentication).

  1. Install Git using Homebrew:
$ brew install git
  1. Install GCM Core using Homebrew:
$ brew tap microsoft/git
$ brew install --cask git-credential-manager-core

For MacOS, you don't need to run git config because GCM Core automatically configures Git for you.

For Linux, install Git and GCM Core, then configure Git to use GCM Core.

  1. Install Git from your distro's packaging system. Instructions will vary depending on the flavor of Linux you run.

  2. Install GCM Core. See the instructions in the GCM Core repo, as they'll vary depending on the flavor of Linux you run.

  3. Configure Git to use GCM Core. There are several backing stores that you may choose from, so see the GCM Core docs to complete your setup. For more information, see "GCM Core Linux."