Skip to content

Conversation

@noahchoii
Copy link
Contributor

Description of Changes

  • Modify the release note generation logic.

Changes to the Release Note Generation Logic

  • Previously, there was a separate text normalization process. However, since all necessary normalization is now performed during the modified changelog generation process, release-note.js simply fetches the content (copy + paste).
  • Since prettier handles all formatting during changelog generation, formatting is not managed here.

Changes to the Release Notes themselves

  • Previously, the changelogs for multiple packages were all contained within a single file.
  • Now, pages are separated by package, allowing users to view only the relevant changes.

Screenshots

Checklist

Before submitting the PR, please make sure you have checked all of the following items.

  • The PR title follows the Conventional Commits convention. (e.g., feat, fix, docs, style, refactor, test, chore)
  • I have added tests for my changes.
  • I have updated the Storybook or relevant documentation.
  • I have added a changeset for this change. (e.g., for any changes that affect users, such as component prop changes or new features).
  • I have performed a self-code review.
  • I have followed the project's coding conventions and component patterns.

@changeset-bot
Copy link

changeset-bot bot commented Dec 23, 2025

⚠️ No Changeset found

Latest commit: 7fcb97c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Dec 23, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
vapor-ui Ready Ready Preview, Comment Dec 24, 2025 4:34am

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 releases.md file, each @vapor-ui package now has its own dedicated Markdown file for release notes. This change aims to enhance user experience by providing more focused and easily navigable information for specific package updates. The underlying generation scripts have also been streamlined, removing redundant processing steps and introducing a new script to manage the creation and content population of these individual release note files.

Highlights

  • Modular Release Notes Structure: The project has transitioned from a single, monolithic releases.md file to individual Markdown files for each @vapor-ui package's release notes. This change significantly improves organization and user navigation, allowing users to easily find updates relevant to specific components.
  • Streamlined Release Note Generation Logic: The process for generating release notes has been simplified. Redundant text normalization and formatting steps have been removed, as these are now handled earlier during the initial changelog generation, making the release-note.js script primarily a content copier.
  • Script Refactoring and Automation: The scripts/changelog/index.js file was updated to remove unused parameters (type and changesets) and commit-specific linking logic from its functions. A new scripts/changelog/release-note.js script was introduced to automate the population of the new package-specific release note files, ensuring existing frontmatter is preserved.

🧠 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
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/release.yml
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 스크립트의 가독성과 유지보수성을 높이기 위한 몇 가지 제안을 리뷰 코멘트로 남겼습니다. 확인 후 반영을 고려해 주시기 바랍니다.

Comment on lines +8 to +17
## 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
Copy link
Contributor

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?

Copy link
Contributor Author

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
Copy link
Contributor

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.

Copy link
Contributor Author

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, '../../');
Copy link
Contributor

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.

Copy link
Contributor Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants