jenkins/sap-jenkins-library

mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00

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

873 B

Raw Blame History

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: architecture knowledge base (command-line + static site generator)
ADR Tools: command-line to create ADRs
ADR Tools Python: command-line to create ADRs
adr-viewer: static site generator
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.