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

ADR supercede is not updating the old adr reference with Superseded by #47

Open
cloudbackenddev opened this issue Jan 6, 2024 · 3 comments

Comments

@cloudbackenddev
Copy link

Iam trying with the ad-j tool to test adr related features and I see supercede functionality is partially working

This is the sequence of steps i followed

  1. adr init -i madr_initial.md -t madr.md -> Initial adr created under doc/adr
  2. Then I issued following command adr new Use Java -> I see new adr created
  3. Marked the status as Accepted in the newly created ADR
  4. Then I issued adr new -s 2 use Golang
  5. new ADR is created and in the new ADR i can see it Supercedes old ADR
  6. But in ADR 2 I don't see Superseded by references as mentioned in the documentation.

Am i missing something?

@adoble
Copy link
Owner

adoble commented Jan 8, 2024

This is a bug. Two points to this:

  1. Inconsistent help information. The README.md file and the help messages produced with adr help new are inconsistent regarding the behavior of the -s flag. Currently, ADR does not change the status of the superseded ADR. This brings me to point 2.

  2. Loss of semantic information. The approach taken means that, once an ADR has been created, all semantic information is lost. In this case it means that where the supersedes information should be placed is lost.

This loss of semantic information is what stalled the further development of ADR-J. Ideally, we need to know that some text such as

Superseded by ADR 3

means

Superseded by ADR {superseded_adr_id}

This also has to work when more than one ADR supersedes an ADR, or when the ADR is not superseded. This is generally a problem for any type of links that one wants to introduce.

Point 1 can be easily solved by making the documentation consistent.

Point 2 would require an extensive rewrite of ADR-J and, I suspect, would also be incompatible with the current release.

@adoble
Copy link
Owner

adoble commented Jan 8, 2024

I've done a partial correction of this (ADR version 3.2.2) that changes the help text (i.e. point 1 above).

Point 2 remains open and so I'll not close this issue.

@adoble
Copy link
Owner

adoble commented Jan 9, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants