docs: Add CHANGELOG.adoc

CHANGELOG.adoc

@@ -0,0 +1,19 @@
+All notable changes to this project will be documented in this file. This change log follows the conventions of http://keepachangelog.com/[keepachangelog.com].
+
+== [unreleased]
+
+=== Added
+
+- Add enable/disable-debug-log handler
+- Add ElinEnableDebugLog and ElinDisableDebugLog commands
+- Add on-callback method to IEvent protocol
+- Add elin.interceptor.handler/callback
+- Add elin#request_async vim function
+
+=== Fixed
+
+- Fix evaluation handlers to return evaluated result value
+- Fix connection component to close socket when error occured in reading bencode loop
+- Fix nrepl component not to send request when disconnected
+
+// generated by git-cliff

bb.edn

@@ -87,6 +87,9 @@
                    :extra-paths ["dev"]
                    :task (exec 'elin.task.check-documents/-main)}
 
+  update-changelog {:doc "Update CHANGELOG.adoc"
+                    :task (shell "git cliff -o CHANGELOG.adoc")}
+
   check {:doc "Check all"
          :depends [clj-kondo-emit generate-test-analysis generate-deps-edn generate-vim-help
                    check-documents lint format-check test]}

cliff.toml

@@ -0,0 +1,78 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+All notable changes to this project will be documented in this file. This change log follows the conventions of http://keepachangelog.com/[keepachangelog.com].\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    == [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    == [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    === {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+// generated by git-cliff
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+skip_tags = "0.0.1"
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "Added" },
+  { message = "^fix", group = "Fixed" },
+  { message = "^deps", group = "Changed" },
+  { message = "^breaking", group = "Removed" },
+  { message = "^docs", skip = true },
+  { message = "^style", group = "Changed" },
+  { message = "^refactor", group = "Changed" },
+  { message = "^test", group = "Fixed" },
+  { message = "^chore", skip = true },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"