-
Notifications
You must be signed in to change notification settings - Fork 10
chore: edit release-note template #401
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
base: changelog
Are you sure you want to change the base?
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary of ChangesHello @noahchoii, 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 significantly refactors how release notes are generated and presented for the Vapor UI project. Instead of a single, comprehensive Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
이 PR은 릴리스 노트 생성 로직을 개선하여, 기존의 단일 릴리스 노트 파일을 패키지별로 분리하는 변경 사항을 담고 있습니다. 이를 위해 기존 update-releases.mjs 스크립트를 제거하고, 새로운 release-note.js 스크립트를 추가하여 각 패키지의 CHANGELOG.md 파일을 웹사이트 문서로 복사하는 역할을 하도록 수정했습니다. 또한, changesets의 changelog 생성 로직(scripts/changelog/index.js)에서 사용되지 않는 코드를 정리했습니다.
전반적으로 PR의 목적에 맞게 변경 사항이 잘 적용되었습니다. 새로 추가된 release-note.js 스크립트의 가독성과 유지보수성을 높이기 위한 몇 가지 제안을 리뷰 코멘트로 남겼습니다. 확인 후 반영을 고려해 주시기 바랍니다.
| ## 1.0.0-beta.7 | ||
|
|
||
| ### Major Changes | ||
|
|
||
| - 2c8f651: Add Tabs, Text, Textinput transform | ||
| - 441e481: Add Dropdown, IconButton, Nav transformer | ||
| - 441e481: add avatar, breadcrumb, card transform | ||
| - 441e481: Add Popover, RadioGroup, Switch Transform | ||
|
|
||
| ### Minor Changes |
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.
To understand the overall flow, is there no other way to update using the manually modified template in the current situation?
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.
Modifying an existing changelog will likely require some preprocessing steps.
If you just want to test the functionality, you can generate arbitrary changeset hash files and then run the pnpm changeset version command!
| { | ||
| "title": "Releases", | ||
| "pages": ["core", "icons", "color-generator", "css-generator", "codemod"], | ||
| "defaultOpen": false |
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.
Is there a reason why DefaultOpen is set to false here?? Since all documentation sites are currently open, I'm wondering if there's a specific reason for this setting.
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.
Since this is a toggle contained within another toggle, I thought its hierarchy differed from other toggles. I also judged that there was no need to open all toggles to display the release notes. It didn't seem like content that absolutely had to be visible immediately upon entering the page!
| const __filename = fileURLToPath(import.meta.url); | ||
| const __dirname = path.dirname(__filename); | ||
|
|
||
| const WORKSPACE_ROOT = path.resolve(__dirname, '../../'); |
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.
[NIT]
This script always seems to run as root. How about handling it with process.cwd()?. It seems that in the CLI, the working directory (cwd) where the process runs is primarily used as the reference point.
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.
I'm not sure I understand correctly, but are you perhaps trying to run the script from a specific directory path rather than the root directory? In what situation would you expect it to run that way?
Description of Changes
Changes to the Release Note Generation Logic
release-note.jssimply fetches the content (copy + paste).Changes to the Release Notes themselves
Screenshots
Checklist
Before submitting the PR, please make sure you have checked all of the following items.