Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updates tool for ADR management to trestle #316

Merged
merged 4 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all 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: 0 additions & 1 deletion .adr-dir

This file was deleted.

27 changes: 27 additions & 0 deletions .github/workflows/validate-adrs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@

name: Validate ADRs

on:
pull_request:
branches:
- main
paths:
- 'docs/architecture/decisions'

jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4

- name: Set up poetry and install
uses: ./.github/actions/setup-poetry
with:
python-version: '3.11'

- name: Run validate adrs
run: trestle author docs validate -tn decisions -hv -tr docs/architecture



6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,11 @@ For workflow diagrams, see the [diagrams](./docs/workflows/) under the `docs` fo

#### Architecture Decisions

We document decisions using [Architectural Decision Records](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions). The team will decide when an ADR will be put in place, but this is generally done to document impactful architectural decisions. [`adr-tools`](https://github.com/npryce/adr-tools) can be used to manage ADRs in the repository located under `docs/architecture/decisions`.
We document decisions using [Architectural Decision Records](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). The team will decide when an ADR will be put in place, but this is generally done to document impactful architectural decisions.

* Create an instance of the ADR template using `trestle author docs create-sample -tn decisions -tr docs/architecture`.
* This can be tested locally via `trestle author docs validate --task-name decisions -hv -tr docs/architecture`


#### Update the `actions` files

Expand Down
Empty file.
17 changes: 17 additions & 0 deletions docs/architecture/.trestle/author/decisions/0.0.1/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
x-trestle-template-version: 0.0.1
title:
status: proposed # Valid statuses are proposed, deferred, rejected, withdrawn or replaced
---

## Context

<!--Add information here that clearly outlines the problem or opportunity that necessitated the decision.-->

## Decision

<!--State the decision here clear and unambiguous. Describe the rationale and the tradeoffs. --->

## Consequences

<!--Add information here on risks and potential impacts or outcomes.--->
19 changes: 0 additions & 19 deletions docs/architecture/decisions/0001-record-architecture-decisions.md

This file was deleted.

17 changes: 17 additions & 0 deletions docs/architecture/decisions/record-architecture-decisions_000.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
x-trestle-template-version: 0.0.1
title: Record architecture decisions
status: accepted # Valid statuses are proposed, accepted, deferred, rejected, withdrawn, or replaced
---

## 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. `trestle` will be used to create and validate these decisions.