File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -76,6 +76,15 @@ Note: The `GH_TOKEN` environment variable is **required** for GitHub API request
7676| `commit-sha` | Full SHA of the signed commit. |
7777| `tag` | Tag of the signed commit. |
7878
79+ # # Release
80+
81+ This project follows [Conventional Commits](https://www.conventionalcommits.org/) and uses a manual release workflow.
82+
83+ 1. Ensure `dist/` is up-to-date by running `npm run bundle`
84+ 2. Trigger the **Release** workflow via `workflow_dispatch` with the desired [semver](https://semver.org/) version
85+ - The workflow bumps `package.json`, creates a signed commit, and tags `v{version}`
86+ 3. The **Changelog** workflow automatically regenerates `CHANGELOG.md` from conventional commits using [git-cliff](https://git-cliff.org/)
87+
7988[ci_badge] : https://github.com/ryancyq/github-signed-commit/actions/workflows/ci.yml/badge.svg
8089[ci_workflows] : https://github.com/ryancyq/github-signed-commit/actions/workflows/ci.yml
8190[coverage_badge] : https://codecov.io/gh/ryancyq/github-signed-commit/graph/badge.svg?token=KZTD2F2MN2
You can’t perform that action at this time.
0 commit comments