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

index generation via adr-log -i produces incorrect path to ADR files #32

Closed
joostpapendorp opened this issue Mar 15, 2020 · 5 comments
Closed
Labels

Comments

@joostpapendorp
Copy link

joostpapendorp commented Mar 15, 2020

Hi,

The last change seems to have introduced an error in the generation, such that the links to the ADRs are broken.
suggested fix: Either insert an extra slash or remove redundant ../[adr-dir]

  • environment: Windows 10, using WinGit console
  • ADR location within project structure:
/docs/[adr-dir]/  
    | 0000-first.md  
    | index.md   

from within [adr-dir], run
adr-log -i

Expected output:

<!-- adrlog -->

- [ADR-0000](0000-first.md) - First

<!-- adrlogstop -->

Actual output:


<!-- adrlog -->

- [ADR-0000](../[adr-dir]0000-first.md) - First

<!-- adrlogstop -->

adr-log -d ./ does produce correct output

@mmadson
Copy link

mmadson commented Oct 21, 2020

I see code was merged to address this bug, will a release be made that includes this fix?

@koppor
Copy link
Member

koppor commented Oct 21, 2020

@mmadson I merged other pull-requests, too and released it. Could you please give it a try.

@mmadson
Copy link

mmadson commented Oct 22, 2020

@mmadson I merged other pull-requests, too and released it. Could you please give it a try.

Thanks so much for pushing the release. Not sure if this is a new bug / regression but I don't recall this being a problem previously. It seems the template.md file is now being considered an ADR and listed in the TOC.

@koppor
Copy link
Member

koppor commented Oct 22, 2020

@mmadson Could you please add a new issue. I hope that someone in #hacktoberfest works on it - or maybe the author of #35.

@koppor koppor closed this as completed Oct 22, 2020
@mmadson
Copy link

mmadson commented Oct 22, 2020

can do. And actually my company supports Hacktoberfest, perhaps I'll tack a crack at contributing. Thanks again for the release.

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

No branches or pull requests

3 participants