From 4a7d97fab7ae31c11a71feb4d710e1eaf0f1ae37 Mon Sep 17 00:00:00 2001
From: reuben olinsky <reubeno@users.noreply.github.com>
Date: Mon, 17 Jun 2024 23:59:54 -0700
Subject: [PATCH] feat: add basic changelog

---
 .cliffignore |  9 ++++++
 CHANGELOG.md | 43 +++++++++++++++++++++++++
 cliff.toml   | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 143 insertions(+)
 create mode 100644 .cliffignore
 create mode 100644 CHANGELOG.md
 create mode 100644 cliff.toml

diff --git a/.cliffignore b/.cliffignore
new file mode 100644
index 00000000..fafa76fa
--- /dev/null
+++ b/.cliffignore
@@ -0,0 +1,9 @@
+# Commits not to include in changelog
+
+a8ba7982d9ca3746cd6f6e3c26783e9d1d765466
+
+448e60c51cb721bd6991c00bc39e926c7a1ffdac
+6db7ffa0d3ccfbf1e757d5a4eb096fd51d65cc19
+5400c8267db15ed56b5758a6fc35667678a5c856
+87ad64f9ae2044d1aa70effd50244491a765c33e
+6567ede8f0a9be622176dc5e840e5b93344aeb15
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000..c3ce81a2
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,43 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🚀 Features
+
+- Implement 'command' builtin (#77)
+- Add stubs for help man page generation
+- Fill out read builtin impl
+- Rework here doc files (#85)
+- Set + validate intentional MSRV (1.72.0) (#86)
+- Add basic changelog
+
+### 🐛 Bug Fixes
+
+- Compgen -W expansion (#78)
+- Don't split completions that aren't file paths (#79)
+- Allow interrupting read builtin, run pipeline cmds in subshell (#81)
+- Add missing flush calls
+
+### 📚 Documentation
+
+- Add crate shields to readme (#74)
+- Add missing code documentation
+
+### Build
+
+- Update dependencies
+- Adjust clippy warnings
+
+## [brush-shell-v0.1.0] - 2024-06-11
+
+### Build
+
+- Prepare for initial release (#68)
+- Enable publishing (#71)
+
+<!-- generated by git-cliff -->
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 00000000..3415dadb
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,91 @@
+# 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
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\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.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
+]
+
+[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 = [
+  # 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 = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 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|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ 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 = "v[0-9].*"
+# regex for skipping tags
+# skip_tags = ""
+# 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