Skip to content

Latest commit

 

History

History
141 lines (96 loc) · 5.74 KB

README.md

File metadata and controls

141 lines (96 loc) · 5.74 KB
Raw

GitHub Automation Scripts 🤖

This repository hosts scripts written in bash and python to automate common Git/GitHub workflows. Normally to connect a local repository to GitHub one has to go to the GitHub website, create a new respository and then add the new GitHub repo as a remote for your local repository. The create_repo script automates this process.

GitHub-Automation-scripts

Status



Table of Content

Tech 🖥️

My Skills

🏗️ Installation

Getting Started

To install and configure the project on your system locally, use the command mentioned below:

curl https://raw.githubusercontent.com/sahil-sagwekar2652/GitHub-Automation-scripts/main/.setup/install.sh | bash

Installation

Requirements:
  • Git Bash installed on your computer.
  • GitHub personal access token. (Go to your GitHub profile -> Settings -> Developer settings -> Personal Access Tokens -> Create new token with all the repository permissions)

Note!!! This script is written exclusively for Git Bash on Windows, you will have to modify it for other shells.

  • Step 1:

Fork and clone the repository locally.

  • Step 2:

Create a github_secrets.py file in the ./scripts folder and define the following variables inside it.

GITHUB_API_TOKEN = "Your GitHub personal access token"
USERNAME = "Your GitHub username"

  • Step 3:

Add the project path to the PATH variable (Recommended)

Run the following command in the project's base directory to add the scripts path to the PATH environment variable.

$ export PATH=$PATH":"$(pwd)"/scripts"

To permanently add the scripts path to the PATH variable, run the below command in the project's root directory. (This file is located in your home directory)

Make sure to backup the .bash_profile file elsewhere before making any changes to it.

$ echo 'export PATH=$PATH''":'"$(pwd)"'/scripts''"' >> ~/.bash_profile

OR

Run the following commands in the project folder to add the scripts to your bin directory

$ cp -r /scripts/* /usr/bin/

How to use

After the installation is complete then the 'create_repo' command should execute in any directory.

  • Run the command with a '-h' flag to see the help menu
create_repo -h
  • Sample usage
create_repo <PATH_NAME> <REPO_NAME>
  • <PATH_NAME> is the path where you want to create the local repository and <REPO_NAME> is the name for your repo
  • Example:
create_repo . test-repo

The result is a local respository is created with a connected remote repository automatically!

👨‍💻 Development

  • Steps to join the project channel on

    • Go to the #self-roles channel and choose the 'contributor' and 'GitHub-Automation-scripts' roles.
    • You will be automatically added to the exclusive project channel.
    • It will be the primary channel for all the discussions related to the project.

  • Checkout the issues tab to find ideas!

  • Want to contribute? Great!
    Make sure to go through the Contributor's Guide. Trust me it wont take long ;).

🪪 License

License

This project is licensed under the MIT license. For more information, please refer to the LICENSE file.

We hope you find these automation scripts helpful in streamlining your Git and GitHub workflows

Contributors