This Bash script streamlines the Git workflow for developers by automating several common tasks associated with setting up, maintaining, and pushing changes to a Git repository. It's designed to save time and reduce the manual steps required during project setup and version control management.
Fun Fact 😄
This very script was used to automate the setup of its own repository. It's a bit like sending a robot back in time to build itself. We've truly come full circle! 🤖🔄😂
If you find this script useful and it makes your Git workflow a bit smoother, I'd deeply appreciate a star (⭐️) on GitHub! It's a simple gesture that goes a long way in supporting creators like myself. Moreover, if you're keen on staying in the loop with this script's evolution and my other projects, hitting that follow button would mean the world to me. Your engagement not only fuels my passion but also shapes the future of this script. Together, let's make Git Workflow Automation even more powerful. Thank you for your support and for considering to follow my journey!
Before you start, ensure you have the following prerequisites installed on your system:
- Git
- Node.js and npm (if your project requires them)
- GitHub CLI
- HomeBrew to install GitHub CLI
This script is designed to run on Unix-like operating systems with native Bash support, such as Linux and macOS. Windows users can run the script through the Windows Subsystem for Linux (WSL)
-
Selective Starting Point: Incorporates a menu system that enables the user to choose a starting step within the script, facilitating flexibility in workflow management.
-
Menu Example
----------------------------------- Starting Git workflow automation... These are the actions I am capable of performing: 1. Downloading a project 2. Creating a new GitHub repository 3. Handling .gitignore 4. Installing node_modules 5. Initializing Git 6. Staging and committing changes 7. Pushing to GitHub Enter a step to start at, or press the Enter key to begin from the start:
-
-
Directory Confirmation: Prompts the user to confirm the working directory before initiating any operations, enhancing safety and accuracy. Allows exiting if the directory is incorrect.
-
Project Download Option: Offers the choice to download a project using either the
tiged(npx tiged command) orgit clonemethod, facilitating easy project setup from a remote repository. This option is presented if a project download step is selected. -
Automatic Repository Creation: Allows the creation of a new GitHub remote repository for the current directory. It initializes the repository as private by default, streamlining the process of going from a local project to a remote repository. This feature includes error handling for creation failures and authentication issues.
-
.gitignoreFile Management: Automatically checks for the presence of a.gitignorefile, offering to create one with a default entries to ignorenode_modulesand.envif missing. This helps in maintaining a clean repository by ignoring unnecessary or sensitive files. -
Intelligent Dependency Installation: Detects the presence of a
package.jsonfile in the project directory and sub directories to determine if dependency installation is necessary. Ifnode_modulesis missing, it prompts the user to install dependencies usingnpm install, ensuring the project dependencies are up to date. -
Git Repository Initialization Check: Verifies if the current directory is already initialized as a Git repository and offers to initialize one if absent, ensuring that version control setup is in place right from the start.
-
Staging and Committing Changes: Provides an interactive interface for staging all changes, with options for a default "Initial Commit" or a custom commit message. Also displays the current Git status and a log of commits after committing, providing a clear overview of the repository's state.
-
Remote Origin Management: Checks for the existence of a remote origin and offers to add or change it, ensuring that the local repository is correctly linked to a remote one. This step includes the option to push changes to the newly set remote repository, ensuring correct linkage.
-
Push Validation and Execution: Before pushing, confirms with the user that everything looks good by displaying the most recent
git statusimmediately prior to push, adding an extra layer of verification to prevent accidental pushes. It manages pushing to GitHub, including setting up the remote origin if not already done. -
Script Exit Points: Includes multiple exit points based on user decisions or if critical steps fail (e.g., directory change, Git repository initialization), ensuring that the script does not proceed without the required setup and validations.
Ensure you have Git, npm (Node Package Manager), and the GitHub CLI installed on your system before using the script. If you haven't set up an alias for the script such as gitwf , please refer to the installation instructions provided with this project for details on how to do so. This alias allows for easy access and execution of the script from anywhere in your terminal.
To use the script, simply type gitwf or the alias you setup into your terminal and press Enter while in the directory you would like your project to be downloaded or the directory of the project you want to run some of the above-mentioned functions on. Follow the interactive prompts to navigate through various Git and project setup tasks, such as confirming the current directory, downloading a project, creating a repository, managing .gitignore, installing node modules, initializing Git, staging and committing changes, and managing remote origins.
This script is designed to improve the efficiency of Git workflows, making it easier for developers to manage their version control tasks and project setups this may not be a perfect fit for your use case, so if you have any suggestion for improvements feel free to submit a issue, pull request and/or start a discussion. I would love to expand the functionality of this script.
First, install the GitHub CLI (gh) if it's not already installed on your machine. Execute the following commands in your terminal:
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install ghAuthenticate with your GitHub account using gh:
gh auth loginFollow the prompts to select your preferred authentication method and set the default git protocol.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"brew install ghgh auth loginFollow the prompts to select your preferred authentication method and set the default git protocol.
To keep your local copy of the project easily updatable as changes are made, we recommend using git clone to download the repository:
git clone https://github.com/PixelHabits/git-workflow-automation.gitThis command will create a new directory named git-workflow-automation that contains the entire project, including the git_workflow.sh script.
To easily run the git_workflow.sh script from anywhere in your terminal, add an alias to your terminal's profile file:
For Bash users:
echo "alias gitwf='bash /path/to/git_workflow.sh'" >> ~/.bashrc
source ~/.bashrcReminder: Ensure you replace /path/to/git_workflow.sh with the actual full path to where you've placed the script in the git-workflow-automation directory.
Note: The alias gitwf in the command above can be changed to whatever you prefer, as long as it does not conflict with existing terminal commands.
For Zsh (macOS) users:
echo "alias gitwf='bash /path/to/git_workflow.sh'" >> ~/.zshrc
source ~/.zshrcTip for macOS users: To easily find the path of a file or directory, you can drag and drop the file into the Terminal window.
Reminder: Ensure you replace /path/to/git_workflow.sh with the actual full path to where you've placed the script in the git-workflow-automation directory.
Note: The alias gitwf in the command above can be changed to whatever you prefer, as long as it does not conflict with existing terminal commands.
To update your local copy with the latest changes from the repository, navigate to the directory that contains the git_workflow.sh script and execute:
cd /path/to/git-workflow-automation
git pullReminder: Replace /path/to/git-workflow-automation with the actual path to the directory. This step ensures you're in the correct location to update your local repository with any new changes.
Tip for macOS users: To easily find the path of a file or directory, you can drag and drop the file into the Terminal window.
Loving the script? Show your support by giving it a ⭐️ on GitHub! And if you want to keep up with my latest projects and updates, I'd be thrilled if you followed me here. Your star and follow mean a lot to me—they motivate me to keep creating and improving. Thanks for using Git Workflow Automation, and I look forward to bringing you even more useful tools!
If you'd like to contribute to the development of the script, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/AmazingFeature). - Make your changes and commit them (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a pull request.
This project is licensed under the GNU General Public License v3.0 - see the GPLv3 license for details. The GNU GPLv3 is a free, copyleft license for software and other kinds of works, offering the freedom to use, modify, and distribute, ensuring that all modifications and derived works are also available under the same license.
Made with contrib.rocks.
Project Link: https://github.com/PixelHabits/git-workflow-automation