Skip to content

Commit

Permalink
chore(deps): ➕ Use cliff to generate changelog automatically.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jisu-Woniu committed Nov 20, 2023
1 parent 4e0e7fd commit 6210782
Show file tree
Hide file tree
Showing 7 changed files with 361 additions and 209 deletions.
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@
"vueuse",
"zeroize",
"zeroizing"
]
],
"conventionalCommits.scopes": ["deps"]
}
69 changes: 69 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Changelog

All notable changes to this project will be documented in this file.

## [unreleased]

### Bug Fixes

- :green_heart: Specify pnpm version.
- :rotating_light: Use different bundle ID.
- :wrench: snake_case to camelCase.
- :wrench: NSIS languages fix.
- :bug: Drag & drop cancel on blurring.
- :rotating_light: Remove unused `use` and rebundant closure.
- :pushpin: Fix pnpm lockfile.
- :lipstick: Merge CSS rules.
- :bug: Fix the color scheme issues.

### Documentation

- :memo: Add build status in README.
- :memo: Add detailed introduction in README.
- :memo: Add links for VS Codium users.

### Features

- :tada: Initial commit.
- :art: Add icon.
- :sparkles: File selection with drag and drop support.
- :sparkles: Add codec for PEM files.
- :sparkles: Add keypair generation.
- :lipstick: Use Vuetify components.
- :lipstick: Update UI and logo.
- :sparkles: Use rPGP to generate full PGP keys.
- :wrench: Update algorithm preference.
- :sparkles: Add basic signing support.
- :lipstick: Polishing frontend.
- :sparkles: Add light/dark mode switch.
- :sparkles: Remember opened tab on refresh.
- :sparkles: Complex scene of FileSelector.

### Miscellaneous Tasks

- :hammer: Try GitHub Actions.
- :green_heart: Add pnpm to GitHub Actions.
- :green_heart: Use pnpm instead of bun
- :wrench: Change Windows language selector.
- :construction_worker: Try fixing GitHub Actions artifacts uploading.
- :pencil2: Fix typo in workflow.

### Refactor

- :fire: Remove unused code and dependencies.
- :wrench: Update config files.
- :recycle: Extract gen_key_pair from write_key_pair.
- :fire: Remove unused icons.
- :adhesive_bandage: Minor fixes.
- :label: Add KeyPair type for better organizing keys.
- :recycle: Add docs and move keygen functions to module `key_pair`.
- :recycle: Move color switcher to a separate component.

### Build

- :art: Add stylelint related tools.
- :art: Add ESLint
- :bookmark: v0.1.0
- :hammer: Add Makefile for some repetitive work.

<!-- generated by git-cliff -->
83 changes: 83 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# 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 | 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 = "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 = "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"
# limit the number of commits included in the changelog.
# limit_commits = 42
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
"@iconify-json/ic": "^1.1.14",
"@mdi/js": "^7.3.67",
"@tauri-apps/cli": "^1.5.6",
"@types/node": "^20.9.0",
"@types/node": "^20.9.2",
"@vitejs/plugin-vue": "^4.5.0",
"@vue/eslint-config-prettier": "^8.0.0",
"@vue/eslint-config-typescript": "^12.0.0",
"@vue/tsconfig": "^0.4.0",
"autoprefixer": "^10.4.16",
"browserslist": "^4.22.1",
"eslint": "^8.53.0",
"eslint": "^8.54.0",
"eslint-plugin-vue": "^9.18.1",
"npm-run-all2": "^6.1.1",
"postcss": "^8.4.31",
Expand Down
Loading

0 comments on commit 6210782

Please sign in to comment.