Skip to content

Commit

Permalink
Update about.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelCurrin authored Apr 26, 2020
1 parent db98f10 commit f249dbc
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,33 @@
**Table of contents:**

- [🚀 Purpose](#-purpose)
- [🎛️ What it does](#️-what-it-does)
- [🎚️ Versioning sequence](#️-versioning-sequence)
- [🎛️ How it works](#️-how-it-works)
- [💽 Pre-requisites](#-pre-requisites)
- [📚 Resources](#-resources)


## 🚀 Purpose

- Auto-Tag can be used whenever you want to create a new [tag](https://github.com/MichaelCurrin/learn-to-code/blob/master/en/topics/version_control/Git/tags.md) in your `git` project.
- Specify a level as major, minor or bug level.
- Auto-Tag will determine the appropriate next tag level based on the latest tag on the local and remote repos. Then it will create it for you, or just show a preview if using a dry run.
- You get to **skip** doing these tedious tasks:
- remember to pull remote tags
- find what the latest tag
- do a mental calculation to figure out the next number
- type out the tag in full without making a typo
AutoTag can be used whenever you want to create a new [tag](https://github.com/MichaelCurrin/learn-to-code/blob/master/en/topics/version_control/Git/tags.md) in your `git` project.

Specify a level as major, minor or bug level as per the [semvar sequence](#-versioning-sequence) standard and AutoTag will increment the tag appropriately in your repo.

AutoTag streamlines your process as you no longer have to tasks that are error-prone or easy to forget.


## 🎛️ What it does

1. Fetch all tags on the remote.
2. Read your latest _git_ tag
3. Figure out and show label for the next tag.
4. Actually create the tag, unless preview flag is used.


**Notes:**

- The tag will be of type _annotated_.
- AutoTag was built to be run locally by hand, but you can add it as part of your release flow.


## 🎚️ Versioning sequence
Expand All @@ -45,20 +56,6 @@ So your new tag will be `v0.2.0`.
Note this project is only intended for versions with `v` prefix.


## 🎛️ How it works

When run, this Auto-Tag will:

1. Fetch all tags on the remote.
2. Read your latest _git_ tag
3. Create and show label for the new tag.
4. Actually create the tag.

Note the tag will be of type _annotated_.

Auto-Tag was built to be run locally by hand, but you can add it as part of your release flow.


## 💽 Pre-requisites

Note this was written for Unix-like systems (Linux and macOS).
Expand All @@ -67,6 +64,7 @@ So you just need [Bash](https://github.com/MichaelCurrin/learn-to-code/blob/mast

The application is a single script. There are no external dependencies.


## 📚 Resources

Inspiration for this project comes from the following:
Expand Down

0 comments on commit f249dbc

Please sign in to comment.