ADR Tool Go

Opinionated version of ADR tool written in go. For general introduction into the topic, please consider to read Architecture Decision Records: A Tool for Experienced Engineers

Installation

Binary Download

Binaries are available for Linux, Mac OS, Windows. Please Check Releases page.

RPM (Fedora, RedHat)

First Add RPM repository

# Docu: https://aholbreich.github.io/rpm-repo/#installation-fedora-centos-redhat
echo '[Holbreich]
name=Holbreich Repository
baseurl=https://aholbreich.github.io/rpm-repo/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/holbreich.repo

install rpm with yum or dnf

sudo dnf install adr-tool

Find support in rpm-repo project home in case of any issues.

Local build

The straightforward way to compile it on your own.

git clone https://github.com/aholbreich/adr-tool.git
cd adr-tool
# compile and put to $(HOME)/bin
make install

Usage

Init configuration

Run

adr init 

before you start working.

Creating a new ADR

adr new how to make CLI tools

this will create a new numbered ADR in folder .adr: 1-how to make CLI tools.md.

Listing existing ADRs

adr list 

Shows you list of your ADRs with corresponding status

Help and Docu

# List all commands
adr -h 

#Example detailed help to a particular subcommand
adr new -h 

Composing, Editing and Change Status of your ADR

User your favored Editor, Open the desired ADR file under ./.adr/ folder change anything.

TODOs

• Add build pipeline
• Add ADR Status Info in listing
• Multi platform binaries
• Too long being not in final status warning
• Add Status transition?
• Color codes?
• Release notes (See https://github.com/git-chglog/git-chglog)

For developers

# VBuild and try local
make build

make test

make clean