ADR Tool Go

Yet another ADR Tool written in Go.

Inspired by the adr-tools but using the Go instead of Bash.

Installation

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

Checkout rpm-repo in case of any issues.

Local build

#Build locally
go build -o adr
# Make available to the system
sudo mv adr /usr/local/bin/adr

# Alternatively make it available to your user only
mv adr ~/bin/adr

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 

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 (Require file parsing)
• Add Status transition?

For developers

# VBuild and try local
go build -o adr

./adr