corani / adr Goto Github PK

When the number of ADRs grows it may be useful to filter / sort them.

I.e. when you mention ADR-0001 in the text, automatically replace this with a hyperlink

At least in the first header we should zero-pad the ADR number, so:

ADR-1. Some title

it becomes

ADR-0001. Some title

To be a bit more consistent.

Instead of only a table format it might be nice to also support e.g. CSV format

Just like the adr template, write the index template to the project so the user can modify it

When creating a new or updating an existing ADR you should be able to provide the superseded ADR via a flag, which would update and link the ADRs.

Embed version into binary and add adr version to show it.

To find ADRs matching some string (perhaps even in the body?)

Both as demonstration as as documentation :)

Currently long lines get wrapped in adr show (correct), but if you add manual line-breaks in the source text (so you don't get ridiculously long lines in most text editors) the line-breaks are kept in the output text (not correct).

Currently adr update only updates the status in the frontmatter, not in the body text. This may be a bit tricky to do, perhaps it would work if we make the status fixed-width and do a search/replace from the original status to the new status.

Alternatively, if we can get the markdown renderer to play nice with the YAML frontmatter (in GitHub it looks reasonable) we could do away with the table in the body altogether.

And keep this updated with every change!

This could also solve #2 and #7

I imagine the config file declares where the ADR root folder is, and perhaps where the template is.

Rather than as a hardcoded string, embed the template

Get a v0.1.0 out ASAP, so users don't have to import a dummy version v0.0.0

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-go action to v5
• chore(deps): update github/codeql-action action to v3
• chore(deps): update golangci/golangci-lint-action action to v6
• chore(deps): update goreleaser/goreleaser-action action to v6
• 🔐 Create all pending approval PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update module github.com/gosimple/slug to v1.14.0
• fix(deps): update module github.com/jedib0t/go-pretty/v6 to v6.5.9
• fix(deps): update module github.com/spf13/cobra to v1.8.1
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Rename or move it, so it's skipped.

1. When updating an ADR the frontmatter is regenerated, this drops any custom fields the user may have added.
2. It may be interesting to allow filtering by custom fields