Skip to content

Simple tool for handling ADRs (Architecture Decision Records), inspired by the original adr-tools.

Notifications You must be signed in to change notification settings

dukemarty/adr-go

Repository files navigation

adr-go logo image

adr-go

Simple tool for handling ADRs (Architecture Decision Records), inspired by existing tools, in particular the original adr-tools as general source, the node.js implementation by phodal and others in particular regarding file and folder structures, and marouni's Go implementation.

Raison d'être

The reason for yet another implementation was basically that at work the phodal tooling was introduced to manage ADRs for our projects, but in general I was not happy with the performance and the user experience I had with it. A Go implementation, which results in a single executable (thereby allowing a simple copy-install instead of something more complex) appealed to me, but my primary requirement was compatibility with the folder and file structures introduced and used by the adr-tools.

After trying out marouni's Go implementation, I decided that it would be easier to start from scratch to recreate the phodal tool, instead to contributing to or forking marounis work. Of course, this does not mean any critique on any of those other tools, but just that for my use case and my user preferences, this

Developer information

Build release version

Based on this stackoverflow article, use this command line to strip debug and symbol information during build:

go build -ldflags "-s -w"

About

Simple tool for handling ADRs (Architecture Decision Records), inspired by the original adr-tools.

Resources

Stars

Watchers

Forks

Packages

No packages published