asiermarques/adrgen

A command-line tool for generating and managing Architecture Decision Records

adrgen's Issues

Is this project still being maintained?

I'm interested in installing it, but I can't find any instructions for how to do so. How would one go about doing that?

Amended and Superseded relation links should not change the status in the previous ADR until the new is accepted

Acceptance criteria

When I create a new ADR with a relation with another one
Then the link is created in the new ADR file
and the relation's link on the previous file is not created either its status is updated

When I updated the status in and ADR file with relation to another file
And the status is accepted
Then the relation link is created in the previous ADR file
and the status is updated too

Generating an history trace from the ADR files

In order to be able to generate reports about the history and evolution of the architecture decisions, as an ADR writer, I need to be able to export a trace to an easily parseable file

Acceptance criteria

Given a target directory configured with ADR files on it
When I execute the history command
Then the adr_history_trace.json file is exported in a specified directory

Set the amend and supersede relations in the meta section of the ADR

In order to improve the integration and automation, as the ADR writer, I need the ADR relations are specified in the meta section of the ADR file

In order to be able to choose to improve the integration and automation, as the ADR writer, I need to have a config parameter to activate the creation of meta relation variables in the ADR files

Acceptance criteria:

Given a file without meta sections and the relations_in_meta config variable is true
When I create a new ADR with a relation
Then the meta section is added with the relation variable in it

Given a file with a meta section and the relations_in_meta config variable is true
When I create a new ADR with a relation
Then the meta section is updated with the relation variable in it

Given a file with a meta section and the relations_in_meta config variable is false
When I create a new ADR with a relation
Then the meta section is not created either updated

Replace CircleCI with Github Action

Github Action has better integration with Github and makes it easier to show the status of PRs and branches.

adrgen ported to Windows ?

Hi,

adrgen looks great. I use it on Linux but some of the machine where I need it are under Windows.
I am quite new to GO. Do you think that porting adrgen to Windows platform could be tricky ?

Thx, Fred.