Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .adr-dir
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/decisions
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# MkDocs build output
site/
# temporary files
tmp/
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# architecture
Technical architecture governance for SciLifeLab infrastructure - ensuring interoperability, standards, and sustainable design
# SciLifeLab Architecture

Technical architecture governance for SciLifeLab infrastructure - ensuring interoperability, standards, and sustainable design
19 changes: 19 additions & 0 deletions docs/decisions/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ADR-0001. Record architecture decisions

Date: 2025-11-25

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
19 changes: 19 additions & 0 deletions docs/decisions/templates/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ADR-NUMBER. TITLE

Date: DATE

## Status

STATUS

## Context

The issue motivating this decision, and any context that influences or constrains the decision.

## Decision

The change that we're proposing or have agreed to implement.

## Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
17 changes: 17 additions & 0 deletions scripts/adr-new
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/bin/bash
# Wrapper for adr-new that formats ADR identifiers as ADR-0001, ADR-0002, etc.
set -e

# Create the ADR using the standard tool
output=$(adr new "$@")

if [ -n "$output" ] && [ -f "$output" ]; then
# Extract the number from filename (e.g., 0002 from 0002-some-title.md)
filename=$(basename "$output")
padded_num=$(echo "$filename" | grep -oE '^[0-9]+')

# Replace "ADR-N." with "ADR-000N." in the file
sed -i "s/^# ADR-[0-9]\+\./# ADR-${padded_num}./" "$output"

echo "$output"
fi