This is a script that's meant to improve workplace efficiency for EnergySage by connecting to the Jira API to maintain a local registry of active tickets and help automatically name branches. It also connects to the GitHub API to assist in the goal of automating company standard processes for git, creating new branches, and more.
You'll need 3 pieces of information for the startup script - your email that Jira uses, which likely follows the format of [email protected]. The second piece you need is a Jira API Token. To get an API Token for your account, follow this link: Jira API Tokens. Then, click the 'Create API Token'. Give it a label, click 'Create', then click 'Copy'. Write this down for the setup. The final piece is a GitHub API Token, which can be generated here: GitHub API Tokens. Click 'Generate new token', then 'classic', and copy the API Key. Make sure to write this down for setup.
First, we need to make a navigate to the home directory, then pull the files from git.
$ cd ~
$ git clone [email protected]:johnfav03/BranchSage.gitNext, let's make some changes to our zshrc file so that we can use the 'egs' shortcut for the script.
$ echo 'egs() { source ~/BranchSage/main.sh $@; }' >> ~/.zshrc
$ source ~/.zshrcNow, lets run the init script and input the relevant information. Email and the two API Tokens are as detailed in Prerequisites, and AWS Login is the profile you'd like to use for AWS, or leave it blank to select seperately each time. As of writing this, the options for AWS Login are 'es-site-standard', 'replica-db-connect', or 'es-site-dev'.
$ egs initCongratulations, you're done! Now you can start running commands.
If you've followed the previous steps, you can run any of the following commands by typing 'egs' followed by the 4-letter word in brackets. For example:
$ egs prepHere are all the available commands:
prep sets up your working environment for you; it navigates to the es-site directory, it opens your virtual environment, and it runs the AWS Login script if you aren't already logged in.
show lists out a basic list of the tickets considered 'active' and stored in the local registry. Alongside each ticket, it prints the current status of the ticket as displayed in Jira. As a note, this intentionally doesn't pull new tickets from Jira, only grow and trim do. Additionally, it will show you the number of comments adn reviews on a pull request in 'Code Review' and it will show you if a ticket labeled 'Awaiting Deployment' has been merged on GitHub by displaying the status as 'Merged'.
trim helps automate your branches by pulling from Jira and updating the local registry by removing any tickets that are marked 'Done'. It then automatically looks for branches that follow the uppercase letters, hyphen, 4 digits, hyphen pattern and cannot be found in the local registry. If found, these branches are deleted.
grow is the opposite of trim; it also pulls from Jira to update the local registry, and then for any tickets that don't have corresponding branches, it will create a new branch with a name generated automatically by the ticket name. As a note, it won't change existing branch names if they follow the EnergySage naming scheme.
swap is a tool to help facilitate quick navigation between branches that correspond to tickets; after using grow, branch names can get quite long. this command takes a parameter of a 4 digit number, or prints a prompt to ask for one if left blank. It then checks out the branch that matches that ticket number. By default, entering '.' as either the parameter or in the prompt will take you to the develop branch.
rest is meant to make restoring files through git quicker; instead of typing the whole file path, this command prints all changed files indexed, then prints a prompt to take in an index. It then restores that file to it's state from the previous commit. By default, entering '.' in the prompt will restore all files.
diff accomplishes the same task as rest, but simply shows you the differences in each file as opposed to restoring them outright.
sync is meant to be run before making a new branch, as it synchronizes develop with the remote codebase and runs make update.
init is the tool that's used to set the needed credentials, including usernames, preferences, and API Tokens. You can run init after populating your info for the first time, and leaving an input blank will leave it as its previous value. You can use this utility to change tokens or usernames if the need ever arises. It works by storing and retrieving your information in a 1Password entry.
a fun surprise!