From b323cd839616e47b8b5ca89e42dda3e8fc97f389 Mon Sep 17 00:00:00 2001
From: LeMarsu <ch.ruelle@lemarsu.com>
Date: Thu, 30 May 2024 02:57:35 +0200
Subject: [PATCH] chore: add CHANGELOG with `git-cliff`

---
 CHANGELOG.md | 71 ++++++++++++++++++++++++++++++++++++++++++
 cliff.toml   | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 shell.nix    |  1 +
 3 files changed, 159 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 cliff.toml

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..864ed8e
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,71 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Features
+
+- Can load lazy plugins
+- Can load lazy plugins via placeholder `cmd`s
+- Loading plugins respect dependencies option
+- Can load lazy plugins on FileType autocommand
+- Introduce new Sloth command with list subcommand
+- Add `Sloth load` subcommand
+
+### Bug Fixes
+
+- Prevent `setup` function to be called twice
+
+### Refactor
+
+- Plugin normalization
+
+### Miscellaneous Tasks
+
+- Delete dead code
+
+## [0.0.5] - 2024-05-28
+
+### Features
+
+- Add real documentation
+
+### Bug Fixes
+
+- Give default init.lua if none provided
+- Remove namePrefix and nameSuffix
+
+### Miscellaneous Tasks
+
+- Refactor lua generation
+- Remove dead code
+
+## [0.0.4] - 2024-05-28
+
+### Features
+
+- Generating plugins lua definition from nix
+- Simplify lua api
+
+## [0.0.3] - 2024-05-26
+
+### Features
+
+- Rename neofalke to sloth-flake.nvim
+- Check inputs of functions with yants
+
+## [0.0.2] - 2024-05-26
+
+### Features
+
+- Can give dependencies to new package
+- Can build package with all config
+- Remove neovim from nix-shell
+- Neoflake and runtime plugin have their version
+
+### Miscellaneous Tasks
+
+- Release v0.0.2
+
+<!-- generated by git-cliff -->
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 0000000..e275c4b
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,87 @@
+# 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]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\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.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+[git]
+# 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 = [
+  # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 1 -->Features" },
+  { message = "^fix", group = "<!-- 2 -->Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->Documentation" },
+  { message = "^perf", group = "<!-- 4 -->Performance" },
+  { message = "^refactor", group = "<!-- 5 -->Refactor" },
+  { message = "^style", group = "<!-- 6 -->Styling" },
+  { message = "^test", group = "<!-- 7 -->Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore: bump version", skip = true },
+  { message = "^chore|ci", group = "<!-- 8 -->Miscellaneous Tasks" },
+  { message = "^flake\\.lock: Update", skip = true },
+  { body = ".*security", group = "<!-- 9 -->Security" },
+  { message = "^revert", group = "<!-- 10 -->Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "[0-9].*"
+
+breaking_always_bump_major = false
+
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42
diff --git a/shell.nix b/shell.nix
index 6f864e8..b0bf329 100644
--- a/shell.nix
+++ b/shell.nix
@@ -8,5 +8,6 @@ with pkgs;
     buildInputs = [
       nil
       sumneko-lua-language-server
+      git-cliff
     ];
   }