feat(v1.0.0): initial release (#3)

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+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).
+
+## [Unreleased]
+
+## [1.0.0] 2022-01-31
+
+### Features
+
+- Finds all files matching and prints out the delete command
+- Does something, but not super happy yet
+- Completing the basic feature set
+- Migrate to dialoguer for a more nice UX on the interactive part (#1)
+- Add `-y` cli flag
+
+### Miscellaneous Tasks
+
+- Adjust readme and usage
+- Small adjustments on the project description
+- Add demo gif and png
+
+<!-- generated by git-cliff -->

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "putzen-cli"
-description = "help keeping your disk clean of build and dependency artifacts"
-version = "0.0.1"
+description = "helps keeping your disk clean of build and dependency artifacts safely"
+version = "1.0.0"
 authors = ["Sven Assmann <[email protected]>"]
 edition = "2021"
 license = "GPL-3.0-only"

README.md

@@ -1,8 +1,10 @@
 # Putzen
 
-> "putzen" is German and means cleaning. Nobody likes "putzen". But it is necessary.
+> "putzen" is German and means cleaning. It helps keeping your disk clean of build and dependency artifacts safely.
 
-## What does putzen?
+![demo](docs/demo.gif)
+
+## What does putzen do?
 
 In short, putzen solves the problem of cleaning up build or dependency artifacts.
 It does so by a simple "File" -> "Folder" rule. If the "File" and "Folder" is present, it cleans "Folder"

cliff.toml

@@ -0,0 +1,60 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog
+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") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on 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 = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# 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"