branch: externals/ellama
commit d3732b9d66c389b23af4ee9a7c89dcf6397778a7
Author: Sergey Kostyaev <[email protected]>
Commit: Sergey Kostyaev <[email protected]>
Move changelog generation to the project-local blueprint
Added blueprints/changelog.ellama-blueprint outlining the procedure to
generate
NEWS.org. Removed docs/changelog.org which was previously for changelog
generation.
---
blueprints/changelog.ellama-blueprint | 21 +++++++++++++++++++++
docs/changelog.org | 3 ---
2 files changed, 21 insertions(+), 3 deletions(-)
diff --git a/blueprints/changelog.ellama-blueprint
b/blueprints/changelog.ellama-blueprint
new file mode 100644
index 0000000000..a99656cb60
--- /dev/null
+++ b/blueprints/changelog.ellama-blueprint
@@ -0,0 +1,21 @@
+Call shell_command tool with "git log --reverse main..HEAD" argument. Based on
+the output write short changelog in org-mode list format. Use "~tildas~"
quoting
+instead of "`backticks`" quoting. Do not add any anknowledgements. Every
+changelog element should be ended with full stop. Changelog shouldn't be too
+short or too long, use detailed description for major changes and concise
+description for minor changes. Write it to ./NEWS.org using prepend_file tool
+with header:
+
+* Version {version}
+
+After header should be changelog content. Content should ends with single
+newline.
+Example:
+ ```text
+* Version {version}
+- Some change description. Some additional information.
+- Major change detailed description. This change improves ~ellama-something~.
+ Some additional information.
+- Third change description.
+- Some fix in ~ellama-example-command~ description.
+```
diff --git a/docs/changelog.org b/docs/changelog.org
deleted file mode 100644
index 9cfaa62fb4..0000000000
--- a/docs/changelog.org
+++ /dev/null
@@ -1,3 +0,0 @@
-Based on shell_command "git log --reverse main..HEAD" output write short
-changelog in markdown list format. Do not add any headings or anknowledgements.
-Every changelog element should be ended with full stop.
