Skip to content

Add ability to link to issue tracking software #145

@thburghout

Description

@thburghout

Feature Request

Feature Suggestion

Often, the issue tracking software (GitHub issues, Jira tickets, etc.) contain more information about the motivation for the ADR. It would be nice to include this information structurally in the ADR header.

Context

Making sure that the cause of a decision is historically tracked.

Possible Implementation

For example, similarly to how GitHub autolink references work. Configure the target URL in .log4brains.yml the :

    issue_target_url: https://example.com/TICKET?query=<num>

And in the ADR include:

 - Issue: ABC-123

Which will render the following in the UI:

<p title="issue"><a href="https://example.com/TICKET?query=ABC-123">ABC-123</a></p>

Possible with a nice generic icon.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions