diff --git a/CONVENTIONAL_COMMITS.md b/CONVENTIONAL_COMMITS.md deleted file mode 100644 index e08252feb..000000000 --- a/CONVENTIONAL_COMMITS.md +++ /dev/null @@ -1,124 +0,0 @@ -# Conventional Commits - -This project uses [Conventional -Commits](https://www.conventionalcommits.org/). Read the -[Summary](https://www.conventionalcommits.org/en/v1.0.0/#summary) or -the [Full -Specification](https://www.conventionalcommits.org/en/v1.0.0/#specification) -to learn more. - -## Types - -Conventional Commits defines _type_ (as in `type(scope): -message`). This section aims at listing the types used inside this -project: - -| Type | Definition | -|-|-| -| `feat` | About a new feature. | -| `fix` | About a bug fix. | -| `test` | About a test (suite, case, runner…). | -| `docs` | About a documentation modification. | -| `refactor` | About a refactoring. | -| `ci` | About a Continuous Integration modification. | -| `chore` | About some cleanup, or regular tasks. | - -## Scopes - -Conventional Commits defines _scope_ (as in `type(scope): message`). This -section aims at listing all the scopes used inside this project: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GroupScopeDefinition
CratessdkAbout the matrix-sdk crate.
appserviceAbout the matrix-sdk-appservice crate.
baseAbout the matrix-sdk-base crate.
commonAbout the matrix-sdk-common crate.
cryptoAbout the matrix-sdk-crypto crate.
indexeddbAbout the matrix-sdk-indexeddb crate.
qrcodeAbout the matrix-sdk-qrcode crate.
sledAbout the matrix-sdk-sled crate.
store-encryptionAbout the matrix-sdk-store-encryption crate.
testAbout the matrix-sdk-test and matrix-sdk-test-macros crate.
BindingsappleAbout the matrix-rust-components-swift binding.
crypto-nodejsAbout the matrix-sdk-crypto-nodejs binding.
crypto-jsAbout the matrix-sdk-crypto-js binding.
crypto-ffiAbout the matrix-sdk-crypto-ffi binding.
ffiAbout the matrix-sdk-ffi binding.
Labsjack-inAbout the jack-in project.
Continuous IntegrationxtaskAbout the xtask project.
- -## Generating `CHANGELOG.md` - -The [`git-cliff`](https://github.com/orhun/git-cliff) project is used -to generate `CHANGELOG.md` automatically. Hence the various -`cliff.toml` files that are present in this project, or the -`package.metadata.git-cliff` sections in various `Cargo.toml` files. - -Its companion, -[`git-cliff-action`](https://github.com/orhun/git-cliff-action) -project, is used inside Github Action workflows. diff --git a/bindings/matrix-sdk-crypto-js/cliff.toml b/bindings/matrix-sdk-crypto-js/cliff.toml deleted file mode 100644 index 26f33b838..000000000 --- a/bindings/matrix-sdk-crypto-js/cliff.toml +++ /dev/null @@ -1,61 +0,0 @@ -# configuration file for git-cliff (0.1.0) - -[changelog] -# changelog header -header = """ -# Matrix SDK Crypto JavaScript 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 | filter(attribute="scope", value="crypto-js") | 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 = """ -""" - -[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 preprocessing the commit messages -commit_preprocessors = [ - { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/matrix-org/matrix-rust-sdk/issues/${2}))"}, -] -# regex for parsing and grouping commits -commit_parsers = [ - { message = "^feat", group = "Features"}, - { message = "^fix", group = "Bug Fixes"}, - { message = "^test", group = "Testing"}, - { message = "^doc", group = "Documentation"}, - { message = "^refactor", group = "Refactoring"}, - { message = "^ci", group = "Continuous Integration"}, - { 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 = "" -# regex for ignoring tags -ignore_tags = "" -# sort the tags chronologically -date_order = false -# sort the commits inside sections by oldest/newest order -sort_commits = "oldest" diff --git a/bindings/matrix-sdk-crypto-nodejs/.npmignore b/bindings/matrix-sdk-crypto-nodejs/.npmignore index 3e3d54025..cebcc362e 100644 --- a/bindings/matrix-sdk-crypto-nodejs/.npmignore +++ b/bindings/matrix-sdk-crypto-nodejs/.npmignore @@ -5,4 +5,3 @@ build.rs *.node *.tgz tsconfig.json -cliff.toml \ No newline at end of file diff --git a/bindings/matrix-sdk-crypto-nodejs/cliff.toml b/bindings/matrix-sdk-crypto-nodejs/cliff.toml deleted file mode 100644 index f2c005219..000000000 --- a/bindings/matrix-sdk-crypto-nodejs/cliff.toml +++ /dev/null @@ -1,61 +0,0 @@ -# configuration file for git-cliff (0.1.0) - -[changelog] -# changelog header -header = """ -# Matrix SDK Crypto Node.js 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 | filter(attribute="scope", value="crypto-nodejs") | group_by(attribute="group") %} - ### {{ group | upper_first }} - {% for commit in commits %} - - {{ commit.id | truncate(length=7, end="") }}{% 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 = """ -""" - -[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 preprocessing the commit messages -commit_preprocessors = [ - { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/matrix-org/matrix-rust-sdk/issues/${2}))"}, -] -# regex for parsing and grouping commits -commit_parsers = [ - { message = "^feat", group = "Features"}, - { message = "^fix", group = "Bug Fixes"}, - { message = "^test", group = "Testing"}, - { message = "^doc", group = "Documentation"}, - { message = "^refactor", group = "Refactoring"}, - { message = "^ci", group = "Continuous Integration"}, - { message = "^chore", group = "Miscellaneous Tasks"}, - { body = ".*security", group = "Security"}, -] -# filter out the commits that are not matched by commit parsers -filter_commits = true -# 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 chronologically -date_order = false -# sort the commits inside sections by oldest/newest order -sort_commits = "oldest"