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

Add Support for MADR created by log4brains #231

Closed
r-vanooyen opened this issue May 31, 2023 · 2 comments
Closed

Add Support for MADR created by log4brains #231

r-vanooyen opened this issue May 31, 2023 · 2 comments

Comments

@r-vanooyen
Copy link

Description

As a user I want to manage my ADR with log4brains because adr-tools are not maintained for 3 years.

Priority

Low

Resolution

I have no budget, please add this feature for free

More information

adr-tools by npryce are not or low under maintenance as the commit history shows. source
The ADR org fork of adr-tools references log4brains to manage ADRs. source

The ADRs which are created by log4brains are in the MADR format:

  • Filename contains not a ID but the date in format yyyyMMdd
  • status is defined in a markdown list after the headline

How to create a MVP:

  1. install log4brains npm install -g log4brains source
  2. init a empty log4brains managed adr project log4brains init with default parameters
  3. create a dsl file which includes !adrs docs/adr
  4. start Structurizr Lite and generate website
  5. open site

Current output in log:
ERROR 1 --- [nio-8080-exec-1] s.l.c.w.FileSystemWorkspaceComponentImpl : com.structurizr.dsl.StructurizrDslParserException: Error importing ADRs from /usr/local/structurizr/docs/adr: java.lang.IllegalArgumentException: A decision with an ID of 2023 already exists in this scope at line 5: !adrs docs/adr

Expected:

  • Should not throw an error
  • should show title and status in overview of Structurizr Lite website
  • should display rendered markdown on detail page of ADR
@simonbrowndotje simonbrowndotje transferred this issue from structurizr/lite May 31, 2023
r-vanooyen referenced this issue in r-vanooyen/structurizr-import May 31, 2023
Added feature to define !adr <path> <fqn> name to a MADR capable importer
@r-vanooyen
Copy link
Author

I created a PR structurizr/import#8 which is probably missing some version changes in gradle.build or missing some code conventions. Can you check the PR?

@simonbrowndotje simonbrowndotje transferred this issue from structurizr/import Jan 11, 2024
@simonbrowndotje
Copy link
Contributor

This has been added by 08e4434

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

No branches or pull requests

2 participants