dukemarty/adr-go

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

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"

adr-go's Issues

Implement 'status' command

Implement 'search' command

Implement 'version' command

Analogous to adr-tools, basically just show version of the tool.

Implement 'init' command

Implement 'serve' command

Analogous to serve command in hg (Mercurial).

Implement 'new' command

Implement 'list' command

Implement 'update' command

Based on

https://github.com/alexisjanvier/adr-tools/blob/master/src/lib/update.ts

• update name by title (index/title string)
• of course, update toc subsequently

Check if 'generate' command makes sense

28.09.2023
After checking what the generate command in our reference implementation by phodral does, I decided that the generate command will be left out. The functionality to update the README/toc is basically already present via the update command, while the generated graph seems not to be important. So unless there is some request for this, there is no need.

Implement 'logs' command

Implement 'export' command

Implement 'edit' command

Command to open a selected ADR in the (configured) standard editor.

Transformation from title to filename is incorrect

"Incorrect" compared to the reference adr-tool application. It should replace spaces with hyphens, not underscores.