-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
chore: Upgrade to pnpm 9, add conventional commit PR title linting #5598
Conversation
❌ Deploy Preview for dev-web-novu failed. Why did it fail? →
|
✅ Deploy Preview for novu-design ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
||
``` | ||
${{ steps.lint_pr_title.outputs.error_message }} | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A friendly message added as a PR comment when the PR title is not conventional, alongside the actions needed to fix it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This only affects the PR title? What about the squash commit message?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It targets the PR title which in turn is used as the squash commit message (the highlighted part of this screenshot). The PR description is not targeted by this action.
This won't target unsquashed commit messages that may have been pushed. That job still lives with the Git-husky pre-commit linting hook. We'll need to enforce squash-merges on Git to ensure all commits on the tree are conventionally titled. Let's have that discussion separately.
This reverts commit 9696a96.
|
||
``` | ||
${{ steps.lint_pr_title.outputs.error_message }} | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This only affects the PR title? What about the squash commit message?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rifont excellent work!
Couple of notes:
- If CM linting requires extra work at this point I'd address it in a separate PR so that this one remains focused on the PNPM upgrade. If it's ready, you can ignore the comment.
- It would be good to move @novu/application-generic from packages to libs. It's an 100% internal package that adds value only to Nest.js apps. I think that we might end up using the workspace: protocol for all the private packages inside
libs
folder but not for the public NPM packages inside the packages folder. The reason is that we publish NPM packages, we need to get rid of thatworkspace:
protocol in package.json.
Point 2 can be addressed in a follow up PR.
"@novu/ee-echo-api": "^0.24.2", | ||
"@novu/ee-shared-services": "^0.24.2", | ||
"@novu/ee-translation": "^0.24.2" | ||
"@novu/ee-auth": "workspace:", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rifont This is gold! It was one of the big blockers to bundling all our source code in a single file in Nest.
@SokratisVidros I agree we should move Regarding replacement of the |
What changed? Why was the change needed?
workspace:
directive, a requirement of PNPM v9. This has the benefit of ensuring we only depend on local packages, avoiding difficult-to-debug versioning mismatch issues.nx release version
, which updates theworkspace:
directive for packages to an actual version. These actual version changes should be reverted after publishing to NPM.Screenshots
Add NX Version release to publish script (dry-run publish)
NB: we should look at upgrading to NX v19 to take advantage of their advanced release script capability.
Bad Conventional Commit types
Bad Conventional Commit Scope
Expand for optional sections
Related enterprise PR
Special notes for your reviewer