-
-
Notifications
You must be signed in to change notification settings - Fork 377
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(release): prepare for 0.20.0 (#97)
- Loading branch information
Showing
4 changed files
with
187 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| [package] | ||
| name = "ratatui" | ||
| version = "0.19.0" | ||
| version = "0.20.0" | ||
| authors = ["Florian Dehau <[email protected]>"] | ||
| description = """ | ||
| A library to build rich terminal user interfaces or dashboards | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Creating a Release | ||
|
|
||
| [crates.io](https://crates.io/crates/ratatui) releases are automated via [GitHub actions](.github/workflows/cd.yml) and triggered by pushing a tag. | ||
|
|
||
| 1. Bump the version in [Cargo.toml](Cargo.toml). | ||
| 2. Ensure [CHANGELOG.md](CHANGELOG.md) is updated. [git-cliff](https://github.com/orhun/git-cliff) can be used for generating the entries. | ||
| 3. Commit and push the changes. | ||
| 4. Create a new tag: `git tag -a v[X.Y.Z]` | ||
| 5. Push the tag: `git push --tags` | ||
| 6. Wait for [Continuous Deployment](https://github.com/tui-rs-revival/ratatui/actions) workflow to finish. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # configuration file for git-cliff | ||
| # see https://github.com/orhun/git-cliff#configuration-file | ||
|
|
||
| [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") }}] - {{ 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 | ||
| | filter(attribute="scope") | ||
| | sort(attribute="scope") %} | ||
| - *({{commit.scope}})* {{ commit.message | upper_first }}{% if commit.breaking %} [**breaking**]{% endif %} | ||
| {%- endfor -%} | ||
| {% raw %}\n{% endraw %}\ | ||
| {%- for commit in commits %} | ||
| {%- if commit.scope -%} | ||
| {% else -%} | ||
| - *(uncategorized)* {{ commit.message | upper_first }}{% if commit.breaking %} [**breaking**]{% endif %} | ||
| {% endif -%} | ||
| {% endfor -%} | ||
| {% endfor %}\n | ||
| """ | ||
| # remove the leading and trailing whitespace 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 | ||
| # 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}](https://github.com/tui-rs-revival/ratatui/issues/${2}))"}, | ||
| { pattern = '(better safe shared layout cache)', replace = "perf(layout): ${1}" }, | ||
| { pattern = '(Clarify README.md)', replace = "docs(readme): ${1}" }, | ||
| { pattern = '(Update README.md)', replace = "docs(readme): ${1}" }, | ||
| { pattern = '(fix typos|Fix typos)', replace = "fix: ${1}" } | ||
| ] | ||
| # regex for parsing and grouping commits | ||
| commit_parsers = [ | ||
| { message = "^feat", group = "<!-- 0 -->Features"}, | ||
| { message = "^fix", group = "<!-- 1 -->Bug Fixes"}, | ||
| { 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\\(pr\\)", skip = true}, | ||
| { message = "^chore\\(pull\\)", skip = true}, | ||
| { message = "^chore", group = "<!-- 7 -->Miscellaneous Tasks"}, | ||
| { body = ".*security", group = "<!-- 8 -->Security"}, | ||
| ] | ||
| # 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 | ||
| # glob pattern for matching git tags | ||
| tag_pattern = "v[0-9]*" | ||
| # regex for skipping tags | ||
| skip_tags = "v0.1.0-rc.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 = "newest" |