Makefile: add adr-gen command to download template from the .github r…

…epo and create a new adr
celestiaorg · Apr 5, 2023 · 2f3d12f · 2f3d12f
1 parent 0334749
commit 2f3d12f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 75 deletions.
diff --git a/Makefile b/Makefile
@@ -127,3 +127,12 @@ test-cover:
 	@echo "--> Generating coverage.txt"
 	@export VERSION=$(VERSION); bash -x scripts/test_cover.sh
 .PHONY: test-cover
+
+## adr-gen: Download the adr template from the celestiaorg/.github repo and
+#create a new adr file with the provided adr number and title.
+#
+# Usage: make adr-gen NUM=016 TITLE=my-adr-title
+adr-gen:
+	@echo "--> Generating adr template"
+	@curl -sSL https://raw.githubusercontent.com/celestiaorg/.github/main/adr-template.md > docs/architecture/adr-$(NUM)-$(TITLE).md
+.PHONY: adr-gen
diff --git a/docs/architecture/adr-template.md b/docs/architecture/adr-template.md