Skip to content

Commit

Permalink
chore: Use correct changelog preset for lerna
Browse files Browse the repository at this point in the history
- Use the conventionalcommits preset for lerna, so we can use exclamation marks to mark breaking changes
  • Loading branch information
mofojed committed Oct 10, 2023
1 parent 645277f commit ccf0c00
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 16 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Over time, forks will get out of sync with the upstream repository. To stay up t
- Use `deephaven/web-client-ui` as the base repository.
- Use your own fork, `<username>/web-client-ui` as the repository to push to.
2. Fill in the information in the Pull Request:

- If you know people who should be reviewers, add them as a reviewer
- Add yourself as the Assignee
- PR titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
Expand All @@ -57,12 +58,16 @@ Over time, forks will get out of sync with the upstream repository. To stay up t
- **chore**: Other changes that don't modify src or test files
- **revert**: Reverts a previous commit
- The `scope` is not required.
- **BREAKING CHANGE:** if your change breaks an existing API in such a way that users of the package affected will need to make some changes to migrate to the newer version, add the `BREAKING CHANGE:` footer to the PR description, detailing the breakage and any migration instructions necessary, e.g.:
- **BREAKING CHANGE:** if your change breaks an existing API in such a way that users of the package affected will need to make some changes to migrate to the newer version, add an exclamation mark to the `type` (e.g. `feat!`), and add the `BREAKING CHANGE:` footer to the PR description, detailing the breakage and any migration instructions necessary, e.g.:

```
feat!: Add 'baz' option
BREAKING CHANGE: The API now takes a new parameter that must be provided.
```
- **NOTE:** Do _not_ use the `!` notation for marking a breaking change - you must use the `BREAKING CHANGE:` footer and include details of the breakage/migration.

- [Link the PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) with any associated issues

3. Submit the PR

## Deephaven Contributor License Agreement (CLA)
Expand Down
3 changes: 2 additions & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@
"publish": {
"distTag": "latest"
}
}
},
"changelogPreset": "conventionalcommits"
}
36 changes: 24 additions & 12 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@
"@deephaven/storage": "file:packages/storage",
"@deephaven/stylelint-config": "file:packages/stylelint-config",
"@deephaven/tsconfig": "file:packages/tsconfig",
"@deephaven/utils": "file:packages/utils"
"@deephaven/utils": "file:packages/utils",
"conventional-changelog-conventionalcommits": "^7.0.2"
}
}

0 comments on commit ccf0c00

Please sign in to comment.