Create 17.2 Pajamas UI kit release notes
Release notes cover all files in the Figma UI kit. These include those used by GitLab team members, and files published to the community.
Figma UI kit files | Published to community |
---|---|
|
Before you start:
- View the release process for detailed information about formatting the release notes.
- View the latest release notes to familiarize yourself with recent changes.
Figma UI Kit release notes tasks
Complete the following items for each release:
Before publishing Figma libraries:
-
Figma release notes tasks: -
Review all merges into Figma UI kit files for this milestone. -
Ensure all merges have a description of the merge in the version history.
-
-
Review and edit the release notes: - Ensure all changes to the Figma UI kit are documented in the release notes.
- Check updates to the release notes for accuracy. For example, ensuring all breaking changes are documented.
- Ensure release note items share consistent formatting.
- Consider combining related updates into a single item when the changes happen in the same release.
Publish Figma libraries:
-
Publish the 📙 Component Library. -
Check for incoming updates to other Figma UI kit files that consume the 📙 Component library. Review, apply, and publish these updates. Add release notes when needed. Take care to check for circular updates back to📙 Component library.
Publish release notes:
-
Create a new issue and draft merge request for next milestone's release notes, assigning to a DRI for the release. -
Link to the new draft MR by adding the following to the top of this milestone's uik-release-notes.md
.## 17.X [_Draft: 17.X release notes_](LINK TO MR)
-
Proceed with a maintainer review and merge of the release notes.
Wrap up:
-
Publish update to the 📙 Component library community file. Keep the existing metadata. -
Create a merge request to back up .fig files of any changed UI kit file to the /ui-kit folder in the Pajamas project.
Edited by Dan MH