File: 0002-implement-as-shell-scripts.md

package info (click to toggle)
adr-tools 3.0.0-2
  • links: PTS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 840 kB
  • sloc: sh: 580; makefile: 42
file content (28 lines) | stat: -rw-r--r-- 645 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# 2. Implement as shell scripts

Date: 2016-02-12

## Status

Accepted

## Context

ADRs are plain text files stored in a subdirectory of the project.

The tool needs to create new files and apply small edits to
the Status section of existing files.

## Decision

The tool is implemented as shell scripts that use standard Unix
tools -- grep, sed, awk, etc.

## Consequences

The tool won't support Windows. Being plain text files, ADRs can
be created by hand and edited in any text editor.  This tool just
makes the process more convenient.

Development will have to cope with differences between Unix
variants, particularly Linux and MacOS X.