From 8c65534e0ab12cc939e4830f4a0efcb8888504c7 Mon Sep 17 00:00:00 2001 From: Anas Elgarhy Date: Mon, 11 Mar 2024 02:55:02 +0200 Subject: [PATCH 1/2] chore(cliff): setup git-cliff --- cliff.toml | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 cliff.toml diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..d35b726 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,100 @@ +[remote.github] +owner = "0x61nas" +repo = "aarty" +# token = "" + +[changelog] +header = """ +# Changelog\n +All notable changes to this project will be documented in this file.\n + +> [!Note] +> this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +""" +# 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 | unique(attribute="message")%} + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n\n +{% if version %} + {% if previous.version %} + > **Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }} + {% endif %} +{% else -%} + {% raw %}\n{% endraw %} +{% endif %} + +{%- macro remote_url() -%} + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} +{%- endmacro -%} +""" +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing s +trim = true +# postprocessors +postprocessors = [ + { pattern = '', replace = "https://github.com/0x61nas/aarty" }, # 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}](/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 = "๐Ÿš€ 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\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ 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].*" +# 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 From 0c3a81712d51b9a614b76aed6cf8694f1c220132 Mon Sep 17 00:00:00 2001 From: Anas Elgarhy Date: Mon, 11 Mar 2024 03:05:10 +0200 Subject: [PATCH 2/2] chore(changelog): introduce the changelog --- CHANGELOG.md | 322 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 322 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..dca2e46 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,322 @@ +# Changelog + +All notable changes to this project will be documented in this file. + + +> [!Note] +> this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [unreleased] + +### โš™๏ธ Miscellaneous Tasks + +- *(cliff)* Setup git-cliff + + + + + +## [0.7.0-alpha.2] - 2024-03-08 + +### โš™๏ธ Miscellaneous Tasks + +- *(docker)* Use alpine:latest as a base image +- *(docker)* Just copy the needed files +- *(cargo)* Bump the ver to 0.7.0-alpha.2 +- *(cargo)* Setup the release profile +- *(docker)* Create docker ignore list +- *(docker)* Patch Cargo.toml +- *(release)* Release plz +- *(release)* Rename the workflow + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.7.0-alpha.1...v0.7.0-alpha.2 + +## [0.7.0-alpha.1] - 2024-02-20 + +### ๐Ÿ› Bug Fixes + +- *(docker)* Fix urls +- *(docker)* Rm man +- *(cargo)* Include benches +- *(docker ci)* Add the permissions + +### โš™๏ธ Miscellaneous Tasks + +- *(justfile)* Depth 70 +- *(docker)* Creat docker file +- *(docker)* Create docker workflow +- *(cargo)* Bump the ver to 0.7.0-alpha.1 + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.6.1-alpha.2...0.7.0-alpha.1 + +## [0.6.1-alpha.2] - 2024-02-02 + +### โš™๏ธ Miscellaneous Tasks + +- *(bench)* Create benches +- *(msrv)* Bump msrv to 1.70 +- *(license)* Allow Zlib and Unicode-DFS-2016 +- *(cargo)* Bump the ver to 0.6.1-alpha.2 + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.6.1-alpha.1...0.6.1-alpha.2 + +## [0.6.1-alpha.1] - 2024-01-30 + +### ๐Ÿ› Bug Fixes + +- *(mergify)* Remove the conflicted config + +### ๐Ÿ“š Documentation + +- The code is very readable btw +- *(readme)* Re-generate the readme +- Add documentation based on the youtube video ([#10](https://github.com/0x61nas/aarty/issues/10)) +- Add the missing docs +- Fix typo + +### โš™๏ธ Miscellaneous Tasks + +- Automatically cancel superseded Actions runs ([#5](https://github.com/0x61nas/aarty/issues/5)) +- Fix typos ([#17](https://github.com/0x61nas/aarty/issues/17)) +- *(check)* Update the branch name and chang the msrv to 1.65 +- *(nostd)* Rm nostd.yml +- *(safety)* Update the branch name +- *(schedule)* Change the branch name +- *(github)* Codeowners create +- *(github)* Create a pull request template +- *(github)* Put useless funding stuff +- *(mergify)* Create `mergify` config +- *(github)* Create issues templates +- *(safety)* Remove loom job +- *(lint)* Deny rust2018idoms and none_ascii_ident and missing debug impl +- *(lint)* Warn missing docs +- *(cargo)* Bump the ver to 0.6.1-alpha.1 + +### Nit + +- Selecting direct minimal versions flag is -Zdirect-minimal-versions ([#16](https://github.com/0x61nas/aarty/issues/16)) + +### Clean + +- Rm DOCS.md + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.6.1...0.6.1-alpha.1 + +## [0.6.1] - 2024-01-28 + +### ๐Ÿš€ Features + +- *(bin)* -v works + +### ๐Ÿ› Bug Fixes + +- Fix typos + +### โš™๏ธ Miscellaneous Tasks + +- *(cargo)* Bump the ver to 0.6.1 + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.6...0.6.1 + +## [0.6] - 2024-01-28 + +### ๐Ÿš€ Features + +- *(rgba)* Make fields pub + +### ๐Ÿ› Bug Fixes + +- Makey cargo-hack happy +- *(minimal-versions)* Add rayon v1.1 and cfg-if v0.1.2 as a transitive dependencies +- *(image)* Make cargo-hack happy +- *(bin)* Require colors feature to build the binary + +### ๐Ÿšœ Refactor + +- Annotate structs with non exhaustive +- Use new api + +### ๐Ÿ“š Documentation + +- Its --help sorry +- Fix the examples +- *(readme)* Re-generate the readme +- Fix typos +- Update code examples + +### โš™๏ธ Miscellaneous Tasks + +- *(bin)* Require the image feature to be enabled when building the bin +- *(justfile)* Add cargo-hack tO check recipe +- *(cargo)* Bump the ver to 0.6 +- *(cargo)* Update cargo.lock + +### Clean + +- Rm -rf .github + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.5...0.6 + +## [0.5] - 2024-01-27 + +### ๐Ÿš€ Features + +- *(crate)* Provide a lib and add the reverse mode +- *(empty)* Add `is_empty` method to `TextImage` +- *(serde)* Impl `serde::Serialize` and `serde::Deserialize` +- *(args)* Use bit manipulation to handle our flags +- *(api)* Take slice instead of ownership the sym set +- Make `image` crate optional and add a uniform api +- *(api)* Improve the colors api +- Use less memory +- *(bin)* Read from stdin if there is no provided path +- Config/buffer +- Text_image impl +- *(text_image)* Add insert/put/get functions +- *(sympols)* Empty set +- Re-export stuff +- *(resize filter)* Add he ability to change the resize filter + +### ๐Ÿ› Bug Fixes + +- *(deps)* Update rust crate log to 0.4.20 +- *(deps)* Update rust crate image to 0.24.7 +- *(deps)* Update rust crate clap to 4.3.21 +- *(char selection)* Handle the edge cases +- *(serde)* Implement `_no_ref` feature and fix `impl_serde` +- *(render)* Increment after check +- *(render)* Don't render the transparent pixels + +### ๐Ÿšœ Refactor + +- *(args)* Remove the `clap` crate and use our custom parser +- Remove `log` and `pretty_env_logger` and `colored` crates from our deps +- Replace bool's with one u8 +- *(args)* Be smarter +- *(bin)* Handle the possible errors +- *(bin)* 2mb +- *(serde)* Rename `impl_serde` feature to `serde` +- *(config)* Re-name `bc` to `background` +- *(text_image)* Rm the unused lifetime +- Remove unused import + +### ๐Ÿ“š Documentation + +- *(crate)* The crate intro +- Add the (main) structs/functions docs +- Modules docs +- Fix typos +- *(sympols)* Sympols set docs +- *(color)* ANSI color docs +- *(sympols)* Pub EMPTY_CHAR +- *(text_image)* Text image docs +- H1 title +- Correct the example +- *(readme)* Generate the readme +- Fix bang +- *(readme)* Re-generate the readme + +### โš™๏ธ Miscellaneous Tasks + +- Remove the garbage +- *(cargo)* Disables binary auto discovery +- *(bin)* Remove the unnecessary sub-dir +- *(cargo)* Un-specifying the `image` crate patch version +- *(git)* Remove `Cargo.lock` entry +- *(cargo)* Track the `Cargo.lock` file +- *(typos)* Create `typos` config +- *(just)* Just create the justfile +- *(git)* Remove AUR submodule +- *(deny)* Create `deny` config +- *(committed)* Create the committed config +- *(codespell)* Create the codespell ignore file +- *(typos)* Ignore .git dir +- *(justfile)* Run codespell in check recipe +- *(justfile)* Just patch the generaed readme +- *(samples)* RM UN-NEEDED SAmples +- Add the contributing guide +- *(readme)* Create readme template +- *(samples)* Add the sample images +- *(cargo)* Update the crate metadata +- *(cargo)* Bump the ver to 0.5 +- *(cargo)* Update cargo.lock +- *(cargo)* Msrv is 1.65 + +### Clean + +- Remove unused Fragment struct +- Remove unused filed +- Rm the screenshots dir +- Rm -rf images + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.4.9...0.5 + +## [0.4.9] - 2023-07-16 + +### ๐Ÿ› Bug Fixes + +- *(deps)* Update rust crate image to 0.24.6 +- *(deps)* Update rust crate clap to 4.3.1 +- *(deps)* Update rust crate pretty_env_logger to 0.5.0 +- *(deps)* Update rust crate log to 0.4.18 +- *(deps)* Update rust crate clap to 4.3.2 +- *(deps)* Update rust crate clap to 4.3.9 +- *(deps)* Update rust crate log to 0.4.19 +- *(deps)* Update rust crate colored to 2.0.4 +- *(deps)* Update rust crate clap to 4.3.12 + +### โš™๏ธ Miscellaneous Tasks + +- *(aur)* Remove the AUR submodule +- *(cargo)* Bump the crate version to 0.4.9 + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.4.8...0.4.9 + +## [0.4.8] - 2023-03-31 + +### ๐Ÿ› Bug Fixes + +- *(deps)* Update rust crate clap to 4.2.1 + +### โš™๏ธ Miscellaneous Tasks + +- *(Mergify)* Configuration update + + + + + +> **Full Changelog**: https://github.com/0x61nas/aarty/compare/0.4.7...0.4.8 + +