GitScripts

Automation scripts that you can use for various Git workflows.

---

Requirements

• Must use bash shell -- right now, these are bash scripts.
• Must also have Python 3 installed, since there are some Python helper scripts included.
• Clone the repo to an easy-to-remember directory.
• In that directory, be sure your files are readable, writeable, and executable by copying this command in your terminal:
  • ls | grep-v "LICENSE" | grep -v "README.md" | grep -v "docs" | grep -v "branchnamerefine.py" | grep -v "remote_repo_parse.py" | xargs chmod 777 GitScripts/<filename>
  • This command should ensure all your shell scripts, which are the very core of GitScripts, are executable, readable, and rewritable.
  • It is recommended that you execute this command every time you do a git push from this upstream repo, so you have scripts that are always ready to be executed.
• Also, open up the qreb script and give the script your usual default branch name (e.g. main or master) at the default_branch variable (no spaces allowed in the line).
• Remember to check which bash to check your actual path that you have the bash shell in. Open up each of the scripts, and put that path for bash in the shebang line (The line that starts with #! at the top of the script).
• Go to ~/.bash_profile or ~/.profile or wherever you have a $PATH variable stored. Add the full directory path to GitScripts into $PATH, then restart your computer so you can start using GitScripts as you would a regular Linux command.

---

Scripts

• mkgit -- creates a local project folder with an empty git repo automatically

  • Usage: mkgit <new_folder_name>
  • must be used in directory where you want to create your new project folder, and that directory should not contain a Git repo itself.

• mkclone -- automatically creates a local clone of a remote Git repo in any directory

  • Usage: mkclone <existing_directory> <remote_repo_url>

• propergitfetch -- fetches remote repo changes. Great for local repos with multiple remote repo connections.

  • Usage: propergitfetch
  • Must be used within a Git repo!

• propergitpull -- pulls in remote repo changes into a specified branch.

  • Usage: propergitpull
  • Must be used within a Git repo!

• quickpull -- automates process of pulling from origin repo to a particular branch in local repo.

  • Usage: quickpull
  • Must be used within a Git repo!

• qreb -- automates process of rebasing your current branch onto tip of main branch.

  • Usage: qreb
  • Must be used within a Git repo!

• mkbare -- automates process of creating a new local bare repository from a local project folder; will give instructions for configuration where needed.

  • Usage: mkbare <new_folder_name_or_path>
  • Can technically use this command anywhere, but best to use the command in the project folder where you want to create the bare repo folder. The project folder now becomes the worktree.
  • You will need to take note of last instruction the command gives you before restarting the terminal or computer to finalize configuration of the bare repository.

• bareclone -- automates process of creating a local bare repository from cloning another local or remote repository.

  • Usage: bareclone <new_folder_name_or_path> <existing_folder_name_or_path>
  • Can be used anywhere!
  • The second argument can be the name or path of a folder with a Git repo on your local machine, or a remote Git repo on a service such as GitHub, BitBucket, GitLab, etc.

• localclone -- automates process of cloning a local project folder containing a Git repo, such that the original repo is now the origin remote repo for the cloned project folder.

  • Usage: localclone <new_folder_name_or_path> <original_folder_name_or_path>
  • Creates clone of a local repo anywhere in filesystem.

• openrepo -- automates process of opening a project folder and its Git repo at a particular branch. Creates a new branch if specified branch is not yet created.

  • Usage: openrepo <existing_folder_name_or_path> <branch_name>
  • Can use this in current repo or anywhere else.

• viewbranches -- allows one to view all connected remote repos, as well as all local and pulled remote branches for a particular local repo

  • Usage: viewbranches <folder_name_or_path>
  • Can use this in current repo or anywhere else.

Wish to contribute?

• You can ask to join the repo via my email (astrobrunner@gmail.com), or via the [Join our group] section in Discussions
  • Read the Contributor Covenant Code of Conduct and my Contributing Guidelines before contributing.
• You can also create an issue to report a bug, a problem, or future enhancement.
• You can discuss any ideas you have in our Ideas section in Discussions, too.
• You can fork the repo, create a branch from your fork, and create a Pull Request for the changes in your branch to merge with my main branch, as well.

Wiki

• Link to GitHub wiki here