add release workflow#67
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary of ChangesHello @elenamik, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on updating package dependencies within a monorepo structure. Specifically, it transitions @valence-protocol/domain-clients-core and @valence-protocol/domain-clients-react from workspace:* references to a fixed version 0.4.0 in their respective package.json files. This change is typically performed to stabilize dependencies for a release, ensuring that published packages rely on specific, immutable versions rather than local workspace links, which aligns with the PR's title hinting at a 'release workflow'. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This PR appears to be part of a release preparation, pinning workspace dependencies to a specific version. While this is a necessary step for publishing, I have a couple of suggestions regarding dependency versioning. Manually changing workspace:* to a fixed version can be error-prone and is usually automated by release tooling in a monorepo. Additionally, using exact versions for dependencies can be overly restrictive. My review comments provide suggestions to use semantic versioning ranges for more flexibility.
A couple of other points:
- The PR title 'add release workflow' is a bit misleading as no workflow file is being added. Something like 'chore: Prepare for 0.4.0 release' would be more accurate.
- The changelogs look updated, so you can tick the checkbox in the PR description.
| "@wallet-ui/react": "^1.1.1", | ||
| "graz": "^0.3.3", | ||
| "@valence-protocol/domain-clients-core": "workspace:*" | ||
| "@valence-protocol/domain-clients-core": "0.4.0" |
There was a problem hiding this comment.
Using an exact version for this dependency is quite restrictive. It would be better to use a caret range (^) to allow for non-breaking updates. This allows consumers of your package to get bug fixes and compatible new features from @valence-protocol/domain-clients-core without you needing to publish a new version of this package.
| "@valence-protocol/domain-clients-core": "0.4.0" | |
| "@valence-protocol/domain-clients-core": "^0.4.0" |
| "@valence-protocol/domain-clients-core": "0.4.0", | ||
| "@valence-protocol/domain-clients-react": "0.4.0", |
There was a problem hiding this comment.
For peerDependencies, it's often better to specify a compatible range rather than an exact version. This gives consumers of your library more flexibility in managing their own dependencies. Using a caret range (^) would allow for any compatible 0.x version, which is generally recommended for peer dependencies to avoid dependency conflicts in the consumer's project.
"@valence-protocol/domain-clients-core": "^0.4.0",
"@valence-protocol/domain-clients-react": "^0.4.0"
Pull Request
Checklist
Description