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

Using superseded adrs with multi package project. #107

Open
mesuutt opened this issue May 5, 2023 · 1 comment
Open

Using superseded adrs with multi package project. #107

mesuutt opened this issue May 5, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@mesuutt
Copy link

mesuutt commented May 5, 2023

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:
@mesuutt mesuutt added the bug Something isn't working label May 5, 2023
@mengano-net
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants