ci: add git-cliff integration

.github/workflows/changelog.yml

@@ -0,0 +1,22 @@
+name: changelog
+on: release
+
+jobs:
+  changelog-gen:
+    name: Generate changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: orhun/git-cliff-action@v1
+        with:
+          config: cliff.toml
+          args: -vv --latest --strip header -c .github/workflows/cliff.toml
+        env:
+          OUTPUT: CHANGELOG.md
+
+      - name: Print the changelog
+        run: cat "${{ steps.git-cliff.outputs.changelog }}"

.github/workflows/cliff.toml

@@ -0,0 +1,79 @@
+# configuration file for git-cliff (0.1.0)
+
+[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://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}]
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        - _({{commit.scope}})_ {{ commit.message | upper_first }}
+        {%- if commit.breaking %}
+        {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+        {%- endif -%}
+    {%- endfor %}
+    {% for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - {{ commit.message | upper_first }}
+            {% if commit.breaking -%}
+            {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+            {% endif -%}
+        {% endif -%}
+    {% endfor -%}
+    {% raw %}{% endraw %}\
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# allow only conventional commits
+# https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^build", group = "<!-- 0 --> Packaging"},
+    { message = "^feat", group = "<!-- 1 --> Features"},
+    { message = "(^bug|^Bug|^fix)", group = "<!-- 2 --> Bugfix"},
+    { message = "^refactor", group = "<!-- 3 --> Refactor"},
+    { message = "^chore", group = "<!-- 4 --> Miscellaneous Tasks"},
+    { message = "^doc", group = "<!-- 5 --> Documentation"},
+    { message = "^revert", group = "<!-- 6 --> Revert"},
+    { message = "^perf", group = "<!-- 7 --> Performance"},
+    { message = "^test", group = "<!-- 8 --> Testing"},
+    { message = "^ci", group = "CI", skip = true},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"
+# 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"
+
+[features]
+preserve_order = ["serde_json/preserve_order"]

CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0-rc]
+
+### <!-- 1 --> Features
+
+- _(installer)_ Nicer rsync output (#2067)
+- _(terminal)_ Lazygit can now be toggled (#2039)
+- Add lualine config for darkplus
+- Last updates before 1.0.0 (#1953)
+- Support new null-ls (#1955)
+- Empty for empty buffers instead of Buffer <#>
+- Improved LSP grouping in lualine
+- Decrease hide in width limit for lualine
+- Add support for fsharp (#2021)
+- Add some messages in uninstall.sh (#1945)
+- Null-ls code_actions interface (#2008)
+- Full compatibility with neovim v0.6 (#2037)
+- Multiple enhancements to lvim-reload (#2054)
+- Bump plugin versions (#2064)
+
+### <!-- 2 --> Bugfix
+
+- _(autopairs)_ Add missing configuration entries (#2030)
+- _(bootstrap)_ Remove hard-coded spellfile option (#2061)
+- _(cmp)_ Revert broken sequential loading (#2002)
+- _(installer)_ Better handling of existing files (#2066)
+- _(lsp)_ Avoid installing an overridden server (#1981)
+- _(lsp)_ Prevent repeated setup call (#2048)
+- _(lualine)_ Change `fg` of section `a` in onedarker (#1909)
+- _(null-ls)_ Allow the same linter and formatter (#1968)
+- _(nvimtree)_ Update settings (#2001)
+- _(nvimtree)_ Restore default mappings + make them customizable (#2007)
+- _(nvimtree)_ Handle paths containing spaces (#2027)
+- _(plugins)_ Typo of pin commit of `treesitter` (#2046)
+- _(terminal)_ Allow disabling the open binding for toggleterm
+- _(windows)_ Autocmd requires forward slashes (#1967)
+- _(windows)_ Remove redundant `resolve` call (#1974)
+- Bump nvim-tree version
+- Formatting
+- Remove duplicate lint messages
+- Allow LunarVim changelog to work outside the lvim directory (#1952)
+- Use an indepdent shadafile from neovim (#1910)
+- Packersync issue when you have large number of plugins (#1922)
+- No idea why this breaks barbar
+- Lsp root can get very annoying when working with multiple languages. User is still able to turn it on.
+- Update jdtls script
+- Correct order for cmp's setup (#1999)
+- Dont close if next char is a close pair and no pairs in same line (#2017)
+- More accessible changelog (#2019)
+- Better default, ignore `.git` in `live_grep` (#2020)
+- No restart required when changing colorscheme (#2026)
+- No longer treat lazygit missing as an error (#2051)
+
+### <!-- 3 --> Refactor
+
+- Deprecate lvim.lang.FOO (#1913) (#1914)
+- More configurable format-on-save (#1937)
+- Load the default keymaps once (#1965)
+
+### <!-- 4 --> Miscellaneous Tasks
+
+- Pin cmp related plugins (#1917)
+- Update lsp installer (#1930)
+- Bump core-plugins version (#1989)
+- Bump core-plugins' version (#2018)
+- Bump core-plugins version (#2031)
+
+<!-- generated by git-cliff -->