-
Notifications
You must be signed in to change notification settings - Fork 273
build: make rake changelog non-destructive; adopt conventional commits #1745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,41 @@ | ||
| # Working conventions for activegraph | ||
|
|
||
| ## Commit messages — Conventional Commits (required going forward) | ||
|
|
||
| All new commits **and PR titles** must follow [Conventional Commits](https://www.conventionalcommits.org/): | ||
|
|
||
| ``` | ||
| type(optional-scope): short imperative subject | ||
| ``` | ||
|
|
||
| PRs are **squash-merged**, so the PR title becomes the single commit on the | ||
| default branch — write the PR title as a conventional commit. | ||
|
|
||
| Types that appear in the generated changelog (see `cliff.toml`): | ||
|
|
||
| | type | Changelog section | | ||
| |--------|-------------------| | ||
| | `feat` | Added | | ||
| | `fix` | Fixed | | ||
| | `perf` | Performance | | ||
|
|
||
| Other valid types are fine but are **excluded** from the changelog: | ||
| `chore`, `ci`, `docs`, `refactor`, `test`, `style`, `build`, `revert`. | ||
|
|
||
| Examples: | ||
| - `feat(node): support composite id_property constraints` | ||
| - `fix(query): escape backticks in relationship type names` | ||
| - `perf: batch index lookups in schema inspection` | ||
| - `ci: skip the matrix on docs-only changes` | ||
|
|
||
| Reference a PR/issue in the subject as `(#1234)` — `cliff.toml` turns it into a link. | ||
|
|
||
| ## CHANGELOG.md | ||
|
|
||
| - The `[Unreleased]` section is generated from conventional commits: | ||
| `rake changelog` (refresh) / `rake "changelog[v12.0.0.beta.8]"` (finalize a | ||
| version at release). | ||
| - The task is **non-destructive**: it only rewrites the top `[Unreleased]`/version | ||
| section and inserts it under the preamble. Everything below is **hand-written | ||
| history from before conventional commits were adopted — never regenerate or | ||
| overwrite it** (git-cliff can't reproduce those non-conventional commits). | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.