Repoinit

Overview

This repository contains setup scripts and templates to initialize different kinds of git repositories. by running an interactive script When this script finishes, the repository will be ready to use!

Installation

(sort of...)

1. In the root folder of the repository you want to setup, run:

   git clone https://github.com/k0kazpt/repoinit.git

2. To "uninstall" (meaning, removing from the root repository tree) simply run:

   rm -rf repoinit

   If you wish to "re-install", re-run step 1. above.

Setting up your repository

After the Installation:

1. Run:

   repoinit/start.sh

2. Choose option "1":

   ### START USING YOUR REPOSITORY ###
   (to abort, Ctrl-C)
   -> Please choose the repo type you
   -> want to configure or to rebuild
   -> the configuration!
   What do you want to do?
   1) First Time Setup
   2) Reset config
   #? 1
   

3. Choose the which repository type you wish to configure:

   Which type of repository will this be?
   1) generic
   2) terraform
   #? 1
   

4. If at any time you are asked for sudo privileges, input your password accordingly (you will only be asked once):

   [sudo] password for XXXXX:
   

5. When presented with the following question (git-chglog configuration):

   ? What is the URL of your repository?
   

   fill this and all following questions with the presented default values:

   ? What is the URL of your repository? https://github.com/k0kazpt/test-cookiecutter
   ? What is your favorite style? github
   ? Choose the format of your favorite commit message <type>(<scope>): <subject>
   ? What is your favorite template style? keep-a-changelog
   ? Do you include Merge Commit in CHANGELOG? Yes
   ? Do you include Revert Commit in CHANGELOG? Yes
   ? In which directory do you output configuration files and templates? .chglog
   

6. ✔ Finished!! ✔

   -> Repo setup successfull!
   

To reset and reconfigure

1. Run:

   repoinit/start.sh

2. Choose option "2":

   ### START USING YOUR REPOSITORY ###
   (to abort, Ctrl-C)
   -> Please choose the repo type you
   -> want to configure or to rebuild
   -> the configuration!
   What do you want to do?
   1) First Time Setup
   2) Reset config
   #? 2
   

3. You'll be shown the following message:

   -> Resetting repository metadata:
   rm -f ../.repo_metadata/.DONE 2>/dev/null
   rm -f ../.repo_metadata/.repo_* 2>/dev/null
   -> To reconfigure, run ./repoinit/start.sh again!
   

4. To reconfigure, follow the instructions in Setting up your repository

---

References

conventional commits

https://www.conventionalcommits.org/

pre-commit hooks

Read the pre-commit hooks document for more info.

git-chglog

Read the git-chglog document for more info.