A typescript remake of Nat Pryce's ADR-Tools
License: GNU General Public License v3.0
🔭 I’m currently working on Remix projects and on tools to make the lives of game server owners (mostly mine) simpler
🤝 I’m looking for help with anything really. Please feel free to submit a PR to any of the public repos, I appreciate all help
🌱 I’m currently honing my management skills and forever playing catch-up with front-end technologies
💬 Ask me about building and managing sustainable teams
⚡ Fun fact: 100% code coverage is just the bare minimum
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.
These updates are currently rate-limited. Click on a checkbox below to force their creation now.
uuid, @types/uuid)@typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint)@commitlint/cli, @commitlint/config-conventional, @commitlint/prompt-cli, rimraf)@semantic-release/commit-analyzer, @semantic-release/github, @semantic-release/npm, @semantic-release/release-notes-generator, semantic-release)@vitest/ui, c8, vitest)@faker-js/faker, @meza/adr-tools, @meza/tsconfig-base, @ryansonshine/commitizen, @ryansonshine/cz-conventional-changelog, @semantic-release/changelog, @semantic-release/commit-analyzer, @semantic-release/git, @semantic-release/github, @semantic-release/npm, @semantic-release/release-notes-generator, @types/inquirer, @types/marked, @types/node, @types/uuid, chalk, commander, copyfiles, core-js, husky, inquirer, install-deps-postmerge, is-ci, marked, mock-cwd, semantic-release, typescript, uuid, yarn)@commitlint/cli, @commitlint/config-conventional, @commitlint/prompt-cli, npm-run-all, rimraf, ts-node)@typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-config-tailored-tunes, eslint-plugin-json, eslint-plugin-security)@vitest/ui, c8, vitest)marked, @types/marked)These updates have all been created already. Click a checkbox below to force a retry/rebase of any.
package.json
@types/inquirer ^8.2.1@types/marked ^4.0.3@types/node ^18.0.0chalk ^5.0.1commander ^9.3.0core-js ^3.19.1inquirer ^9.0.0marked ^4.0.17@commitlint/cli ^17.0.2@commitlint/config-conventional ^17.0.2@commitlint/prompt-cli ^17.0.0@faker-js/faker ^7.3.0@meza/adr-tools ^1.0.10@meza/tsconfig-base ^1.1.0@ryansonshine/commitizen ^4.2.8@ryansonshine/cz-conventional-changelog ^3.3.4@semantic-release/changelog ^6.0.1@semantic-release/commit-analyzer ^9.0.2@semantic-release/git ^10.0.1@semantic-release/github ^8.0.4@semantic-release/npm ^9.0.1@semantic-release/release-notes-generator ^10.0.3@types/uuid ^8.3.4@typescript-eslint/eslint-plugin ^5.29.0@typescript-eslint/parser ^5.3.0@vitest/ui ^0.16.0c8 ^7.11.3copyfiles ^2.4.1eslint ^8.1.0eslint-config-tailored-tunes ^5.0.2eslint-plugin-json ^3.1.0eslint-plugin-security ^1.5.0husky ^8.0.1install-deps-postmerge ^2.0.1is-ci ^3.0.1mock-cwd ^1.0.0npm-run-all ^4.1.5rimraf ^3.0.2semantic-release ^19.0.3ts-node ^10.8.1typescript ^4.4.4uuid ^8.3.2vitest ^0.15.2yarn ^1.22.17
see: npryce/adr-tools#102
adr generate toc -p foo/doc/adr/
adr new First Decision
doc/adr/0001-first-decision.md
adr new Second Decision
doc/adr/0002-second-decision.md
adr new Third Decision
doc/adr/0003-third-decision.md
adr generate toc -p foo/doc/adr/
# Architecture Decision Records
* [1. First Decision](foo/doc/adr/0001-first-decision.md)
* [2. Second Decision](foo/doc/adr/0002-second-decision.md)
* [3. Third Decision](foo/doc/adr/0003-third-decision.md)
adr init
doc/adr/0001-record-architecture-decisions.md
adr new An idea that seems good at the time
doc/adr/0002-an-idea-that-seems-good-at-the-time.md
adr new -s 2 A better idea
doc/adr/0003-a-better-idea.md
adr new This will work
doc/adr/0004-this-will-work.md
adr new -s 3 The end
doc/adr/0005-the-end.md
# with default root and extension in links
adr generate graph
digraph {
node [shape=plaintext];
subgraph {
_1 [label="1. Record architecture decisions"; URL="0001-record-architecture-decisions.html"];
_2 [label="2. An idea that seems good at the time"; URL="0002-an-idea-that-seems-good-at-the-time.html"];
_1 -> _2 [style="dotted", weight=1];
_3 [label="3. A better idea"; URL="0003-a-better-idea.html"];
_2 -> _3 [style="dotted", weight=1];
_4 [label="4. This will work"; URL="0004-this-will-work.html"];
_3 -> _4 [style="dotted", weight=1];
_5 [label="5. The end"; URL="0005-the-end.html"];
_4 -> _5 [style="dotted", weight=1];
}
_3 -> _2 [label="Supercedes", weight=0]
_5 -> _3 [label="Supercedes", weight=0]
}
# with specified root and extension in links
adr generate graph -p http://example.com/ -e .xxx
digraph {
node [shape=plaintext];
subgraph {
_1 [label="1. Record architecture decisions"; URL="http://example.com/0001-record-architecture-decisions.xxx"];
_2 [label="2. An idea that seems good at the time"; URL="http://example.com/0002-an-idea-that-seems-good-at-the-time.xxx"];
_1 -> _2 [style="dotted", weight=1];
_3 [label="3. A better idea"; URL="http://example.com/0003-a-better-idea.xxx"];
_2 -> _3 [style="dotted", weight=1];
_4 [label="4. This will work"; URL="http://example.com/0004-this-will-work.xxx"];
_3 -> _4 [style="dotted", weight=1];
_5 [label="5. The end"; URL="http://example.com/0005-the-end.xxx"];
_4 -> _5 [style="dotted", weight=1];
}
_3 -> _2 [label="Supercedes", weight=0]
_5 -> _3 [label="Supercedes", weight=0]
}
See: npryce/adr-tools#112
adr new Something About Node.JS
adr new Slash/Slash/Slash/
adr new -- "-Bar-"
ls doc/adr
adr new Something About Node.JS
doc/adr/0001-something-about-node-js.md
adr new Slash/Slash/Slash/
doc/adr/0002-slash-slash-slash.md
adr new -- "-Bar-"
doc/adr/0003-bar.md
ls doc/adr
0001-something-about-node-js.md
0002-slash-slash-slash.md
0003-bar.md
adr new First Record
doc/adr/0001-first-record.md
mkdir subdir
cd subdir
adr new Second Record
../doc/adr/0002-second-record.md
adr list
../doc/adr/0001-first-record.md
../doc/adr/0002-second-record.md
cd ..
adr list
doc/adr/0001-first-record.md
doc/adr/0002-second-record.md
adr init architecture-log
architecture-log/0001-record-architecture-decisions.md
adr new First Record
architecture-log/0002-first-record.md
mkdir subdir
cd subdir
adr new Second Record
../architecture-log/0003-second-record.md
adr list
../architecture-log/0001-record-architecture-decisions.md
../architecture-log/0002-first-record.md
../architecture-log/0003-second-record.md
cd ..
adr list
architecture-log/0001-record-architecture-decisions.md
architecture-log/0002-first-record.md
architecture-log/0003-second-record.md
This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.
These updates are currently rate-limited. Click on a checkbox below to force their creation now.
uuid, @types/uuid)@typescript-eslint/eslint-plugin, @typescript-eslint/parser)@commitlint/cli, @commitlint/config-conventional, @commitlint/prompt-cli, rimraf)@semantic-release/commit-analyzer, @semantic-release/github, @semantic-release/npm, @semantic-release/release-notes-generator, semantic-release)@vitest/ui, c8, vitest)@faker-js/faker, @meza/adr-tools, @meza/tsconfig-base, @ryansonshine/commitizen, @ryansonshine/cz-conventional-changelog, @semantic-release/changelog, @semantic-release/commit-analyzer, @semantic-release/git, @semantic-release/github, @semantic-release/npm, @semantic-release/release-notes-generator, @types/inquirer, @types/marked, @types/node, @types/uuid, chalk, commander, copyfiles, core-js, husky, inquirer, install-deps-postmerge, is-ci, marked, mock-cwd, semantic-release, typescript, uuid, yarn)@commitlint/cli, @commitlint/config-conventional, @commitlint/prompt-cli, npm-run-all, rimraf, ts-node)@typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, eslint-config-tailored-tunes, eslint-plugin-json, eslint-plugin-security)@vitest/ui, c8, vitest)marked, @types/marked)These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.
package.json
@types/inquirer ^8.2.1@types/marked ^4.0.3@types/node ^18.0.0chalk ^5.0.1commander ^9.3.0core-js ^3.19.1inquirer ^9.0.0marked ^4.0.17@commitlint/cli ^17.0.2@commitlint/config-conventional ^17.0.2@commitlint/prompt-cli ^17.0.0@faker-js/faker ^7.3.0@meza/adr-tools ^1.0.10@meza/tsconfig-base ^1.1.0@ryansonshine/commitizen ^4.2.8@ryansonshine/cz-conventional-changelog ^3.3.4@semantic-release/changelog ^6.0.1@semantic-release/commit-analyzer ^9.0.2@semantic-release/git ^10.0.1@semantic-release/github ^8.0.4@semantic-release/npm ^9.0.1@semantic-release/release-notes-generator ^10.0.3@types/uuid ^8.3.4@typescript-eslint/eslint-plugin ^5.29.0@typescript-eslint/parser ^5.3.0@vitest/ui ^0.16.0c8 ^7.11.3copyfiles ^2.4.1eslint ^8.1.0eslint-config-tailored-tunes ^5.0.2eslint-plugin-json ^3.1.0eslint-plugin-security ^1.5.0husky ^8.0.1install-deps-postmerge ^2.0.1is-ci ^3.0.1mock-cwd ^1.0.0npm-run-all ^4.1.5rimraf ^3.0.2semantic-release ^19.0.3ts-node ^10.8.1typescript ^4.4.4uuid ^8.3.2vitest ^0.15.2yarn ^1.22.17
-s SUPERCEDED A reference (number or partial filename) of a previous decision that the new decision supercedes. A Markdown link to the superceded ADR is inserted into the Status section. The status of the superceded ADR is changed to record that it has been superceded by the new ADR.
adr new First Record
doc/adr/0001-first-record.md
adr new -s 1 Second Record
doc/adr/0002-second-record.md
head -10 doc/adr/0001-first-record.md
# 1. First Record
Date: 1992-01-12
## Status
Superceded by [2. Second Record](0002-second-record.md)
## Context
head -12 doc/adr/0002-second-record.md
# 2. Second Record
Date: 1992-01-12
## Status
Accepted
Supercedes [1. First Record](0001-first-record.md)
## Context
-l TARGET:LINK:REVERSE-LINK Links the new ADR to a previous ADR. TARGET is a reference (number or partial filename) of a previous decision. LINK is the description of the link created in the new ADR. REVERSE-LINK is the description of the link created in the existing ADR that will refer to the new ADR.
adr new First Record
doc/adr/0001-first-record.md
adr new Second Record
doc/adr/0002-second-record.md
adr new -l "1:Amends:Amended by" -l "2:Clarifies:Clarified by" Third Record
doc/adr/0003-third-record.md
head -12 doc/adr/0001-first-record.md
# 1. First Record
Date: 1992-01-12
## Status
Accepted
Amended by [3. Third Record](0003-third-record.md)
## Context
head -12 doc/adr/0002-second-record.md
# 2. Second Record
Date: 1992-01-12
## Status
Accepted
Clarified by [3. Third Record](0003-third-record.md)
## Context
head -14 doc/adr/0003-third-record.md
# 3. Third Record
Date: 1992-01-12
## Status
Accepted
Amends [1. First Record](0001-first-record.md)
Clarifies [2. Second Record](0002-second-record.md)
## Context
adr generate toc -i intro.md -o outro.md
See: npryce/adr-tools#61
If the ADR directory contains a file templates/template.md, this is used as the template for the new ADR. Otherwise a default template is used
adr init adrs
adrs/0001-record-architecture-decisions.md
mkdir -p adrs/templates
cat > adrs/templates/template.md <<EOF
# TITLE
Project specific template!
# Status
STATUS
# Info
ADR Number: NUMBER
Date: DATE
EOF
adr new Aaa Bbb
adrs/0002-aaa-bbb.md
adr new Ccc Ddd
adrs/0003-ccc-ddd.md
cat adrs/0002-aaa-bbb.md
# Aaa Bbb
Project specific template!
# Status
Accepted
# Info
ADR Number: 2
Date: 1992-01-12
cat adrs/0003-ccc-ddd.md
# Ccc Ddd
Project specific template!
# Status
Accepted
# Info
ADR Number: 3
Date: 1992-01-12
adr list
The doc/adr directory does not exist
adr new first
doc/adr/0001-first.md
adr list
doc/adr/0001-first.md
adr new second
doc/adr/0002-second.md
adr list
doc/adr/0001-first.md
doc/adr/0002-second.md
adr new third
doc/adr/0003-third.md
adr list
doc/adr/0001-first.md
doc/adr/0002-second.md
doc/adr/0003-third.md
## Multiple -s and -l options can be given, so that the new ADR can supercede
## or link to multiple existing ADRs.
##
## E.g. to create a new ADR with the title "Use MySQL Database":
##
## adr new Use MySQL Database
##
## E.g. to create a new ADR that supercedes ADR 12:
##
## adr new -s 12 Use PostgreSQL Database
##
## E.g. to create a new ADR that supercedes ADRs 3 and 4, and amends ADR 5:
##
## adr new -s 3 -s 4 -l "5:Amends:Amended by" Use Riak CRDTs to cope with scale
##
adr new First Record
doc/adr/0001-first-record.md
adr new Second Record
doc/adr/0002-second-record.md
adr new -s 1 -s 2 Third Record
doc/adr/0003-third-record.md
head -8 doc/adr/0001-first-record.md
# 1. First Record
Date: 1992-01-12
## Status
Superceded by [3. Third Record](0003-third-record.md)
head -8 doc/adr/0002-second-record.md
# 2. Second Record
Date: 1992-01-12
## Status
Superceded by [3. Third Record](0003-third-record.md)
head -12 doc/adr/0003-third-record.md
# 3. Third Record
Date: 1992-01-12
## Status
Accepted
Supercedes [1. First Record](0001-first-record.md)
Supercedes [2. Second Record](0002-second-record.md)
Just tried adr and was faced with init command not working on Windows.
Looks like an infinite loop cause Windows doesn't have /
adr init alt/directory should create a config file .adr-dir and then creating new adrs should use that dir
## usage: adr link SOURCE LINK TARGET REVERSE-LINK
##
## Creates a link between two ADRs, from SOURCE to TARGET new.
## SOURCE and TARGET are both a reference (number or partial filename) to an ADR
## LINK is the description of the link created in the SOURCE.
## REVERSE-LINK is the description of the link created in the TARGET
##
## E.g. to create link ADR 12 to ADR 10
##
## adr link 12 Amends 10 "Amended by"
##
The ADR is opened for editing in the editor specified by the VISUAL or EDITOR environment variable (VISUAL is preferred; EDITOR is used if VISUAL is not set). After editing, the file name of the ADR is output to stdout, so the command can be used in scripts.
main branch failed. 🚨I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.
You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.
Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.
Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.
If you are not sure how to resolve this, here are some links that can help you:
If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.
1.0.10 on branch main cannot be published as it is out of range.Based on the releases published on other branches, only versions within the range >=1.0.9 <1.0.10 can be published from branch main.
The following commits are responsible for the invalid release:
Those commits should be moved to a valid branch with git merge or git cherry-pick and removed from branch main with git revert or git reset.
A valid branch could be next.
See the workflow configuration documentation for more details.
Good luck with your project ✨
Your semantic-release bot 📦🚀
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.