mirror of
https://github.com/swc-project/swc.git
synced 2024-12-23 13:51:19 +03:00
chore: Add changelog and pr template (#3017)
Co-authored-by: Donny <kdy1997.dev@gmail.com>
This commit is contained in:
parent
69123ddc28
commit
aab3326b3e
14
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
14
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. -->
|
||||||
|
|
||||||
|
**Description:**
|
||||||
|
|
||||||
|
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
|
||||||
|
|
||||||
|
**BREAKING CHANGE:**
|
||||||
|
<!--
|
||||||
|
If this PR introduces a breaking change, it must contain a notice for it to be included in the CHANGELOG. Add description or remove entirely if not breaking.
|
||||||
|
|
||||||
|
You may need to update `MIGRATION.md` for the breaking changes.
|
||||||
|
-->
|
||||||
|
|
||||||
|
**Related issue (if exists):**
|
3348
CHANGELOG.md
Normal file
3348
CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
71
cliff.toml
Normal file
71
cliff.toml
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
# configuration file for git-cliff (0.1.0)
|
||||||
|
|
||||||
|
[changelog]
|
||||||
|
# changelog header
|
||||||
|
header = """
|
||||||
|
# Changelog
|
||||||
|
"""
|
||||||
|
# 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
|
||||||
|
| filter(attribute="scope")
|
||||||
|
| sort(attribute="scope") %}
|
||||||
|
\n
|
||||||
|
- **({{commit.scope}})** {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/swc-project/swc/commit/{{ commit.id }}))
|
||||||
|
{%- if commit.breaking %}
|
||||||
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
||||||
|
{%- endif -%}
|
||||||
|
{%- endfor -%}
|
||||||
|
\n\n
|
||||||
|
{%- for commit in commits %}
|
||||||
|
{%- if commit.scope -%}
|
||||||
|
{% else -%}
|
||||||
|
\n
|
||||||
|
- **general**: {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/swc-project/swc/commit/{{ commit.id }}))
|
||||||
|
{%- if commit.breaking %}
|
||||||
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
||||||
|
{%- endif -%}
|
||||||
|
{% endif -%}
|
||||||
|
{% endfor -%}
|
||||||
|
{% raw %}\n{% endraw %}\
|
||||||
|
{% endfor %}\n
|
||||||
|
"""
|
||||||
|
# remove the leading and trailing whitespaces from the template
|
||||||
|
trim = true
|
||||||
|
# changelog footer
|
||||||
|
footer = """
|
||||||
|
<!-- generated by git-cliff -->
|
||||||
|
"""
|
||||||
|
|
||||||
|
[git]
|
||||||
|
# allow only conventional commits
|
||||||
|
# https://www.conventionalcommits.org
|
||||||
|
conventional_commits = true
|
||||||
|
filter_unconventional = false
|
||||||
|
# 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: Publish", 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"
|
@ -52,6 +52,7 @@
|
|||||||
"optionalDependencies": {},
|
"optionalDependencies": {},
|
||||||
"types": "./index.d.ts",
|
"types": "./index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
"changelog": "git cliff --output CHANGELOG.md",
|
||||||
"prepare": "husky install && git config feature.manyFiles true",
|
"prepare": "husky install && git config feature.manyFiles true",
|
||||||
"artifacts": "napi artifacts --dist scripts/npm",
|
"artifacts": "napi artifacts --dist scripts/npm",
|
||||||
"prepublishOnly": "tsc -d && napi prepublish -p scripts/npm --tagstyle npm",
|
"prepublishOnly": "tsc -d && napi prepublish -p scripts/npm --tagstyle npm",
|
||||||
|
Loading…
Reference in New Issue
Block a user