1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
sap-jenkins-library/documentation/adr/20221004-use-log4brains-to-manage-the-adrs.md
Oliver Nocon e44aaf86e4
chore: prepare setup for future ADRs (#4054)
* chore: prepare setup for future ADRs

* Update build-adr.yml
2022-11-02 14:30:34 +01:00

23 lines
873 B
Markdown

# Use Log4brains to manage the ADRs
- Status: accepted
- Date: 2022-10-03
- Tags: dev-tools, doc
## Context and Problem Statement
We want to record architectural decisions made in this project.
Which tool(s) should we use to manage these records?
## Considered Options
- [Log4brains](https://github.com/thomvaill/log4brains): architecture knowledge base (command-line + static site generator)
- [ADR Tools](https://github.com/npryce/adr-tools): command-line to create ADRs
- [ADR Tools Python](https://bitbucket.org/tinkerer_/adr-tools-python/src/master/): command-line to create ADRs
- [adr-viewer](https://github.com/mrwilson/adr-viewer): static site generator
- [adr-log](https://adr.github.io/adr-log/): command-line to create a TOC of ADRs
## Decision Outcome
Chosen option: "Log4brains", because it includes the features of all the other tools, and even more.