thomvaill / log4brains

✍️ Log and publish your architecture decisions (ADR)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Using superseded adrs with multi package project.

mesuutt opened this issue · comments

Bug Report

Description

We want to use superseded adrs.
We updated Status of the superseded doc like below:

- Status: superseded by [20201029-superseder](20201029-superseder.md)

And we added link to superseded doc in superseder doc like below:

- Supersedes [20201028-superseded-adr](20201028-superseded-adr.md)

When we clicked to superseded adr from adr list it returns 500 response and we got Error: You forgot to pass the superseder error from terminal.

Steps to Reproduce

project:
  name: my adrs
  tz: Europe/Istanbul
  packages:
    - name: mypackage
      path: ./mypackage
      adrFolder: ./mypackage/docs/adr

Directory structure is like below:

.
├── mypackage
│ ├── docs
│ │ └── adr
│ │     ├── 20201028-superseded-adr.md
│ │     └── 20201029-superseder.md

Expected Behavior

Superseded ADRs in multi package project should be work like mono package project.
We tried with mono package structure and it worked like expected.

Context

We want to create ADRs in multi package project structure.

Environment

  • Log4brains version: 1.0.1
  • Node.js version: v19.6.0
  • OS and its version: MacOs Darwin 22.4.0 Darwin Kernel Version 22.4.0:

Hi, great project, we are using it to manage ADR's, thanks!

I'm also having this problem. I tested it with monolithic project but doesn't seem to work properly with muti-package project. In case it helps troubleshooting, here is a workaround.

  • replaced this line
- Status: superseded by
   [20230524-product-catalog-aws-s3-best-practices](20230524-product-catalog-aws-s3-best-practices.md)
  • ... with this
- Status: superseded by [](20230403-product-catalog-aws-s3-best-practices.md)
  • I then added at the bottom a link to superseded ADR to aid with navigation.

Result:

  • All links work

  • Here is the top of the superseded ADR
    top

  • ... and the bottom
    bottom