Release tracking

[primer-css]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@primer/[email protected]

Minor Changes

• #774 a6baf41d Thanks @joshfarrant! - Fixed issue where Button component would reflow and break over multiple lines when its text content exceeded the viewport width.

  ⚠️ Breaking changes to the following design tokens:

  - --brand-control-medium-paddingBlock
  + --brand-control-medium-paddingBlock-normal

  - --brand-control-large-paddingBlock
  + --brand-control-large-paddingBlock-normal

  Additional tokens added:

  + --brand-control-medium-paddingBlock-condensed
  + --brand-control-large-paddingBlock-condensed

Patch Changes

• #791 8105b6a3 Thanks @joshfarrant! - Increased spacing between River components on narrow viewports from 28px to 36px

• #769 41531950 Thanks @danielguillan! - Adjust text 800 line height

@primer/[email protected]

Minor Changes

• #779 b5c291e2 Thanks @joshfarrant! - Accessibility improvements to the FormControl.Hint component.

  • FormControl.Hint is now automatically associated with the form field using aria-describedby.
  • Improvements to the styling of FormControl.Hint when used alongside a Checkbox.

Patch Changes

• #791 8105b6a3 Thanks @joshfarrant! - Increased spacing between River components on narrow viewports from 28px to 36px

• #776 06fd8476 Thanks @joshfarrant! - Added aria-describedby attribute to leading/trailing text and visuals in TextInput component

• #781 ec6ffc36 Thanks @joshfarrant! - - Card component no longer expands to full width when fullWidth={false}

  • Card component no longer renders duplicate borders in dark mode when hasBorder={true}

• #774 a6baf41d Thanks @joshfarrant! - Fixed issue where Button component would reflow and break over multiple lines when its text content exceeded the viewport width.

  ⚠️ Breaking changes to the following design tokens:

  - --brand-control-medium-paddingBlock
  + --brand-control-medium-paddingBlock-normal

  - --brand-control-large-paddingBlock
  + --brand-control-large-paddingBlock-normal

  Additional tokens added:

  + --brand-control-medium-paddingBlock-condensed
  + --brand-control-large-paddingBlock-condensed

• #728 c6ee839e Thanks @MelissaPastore! - Fixed a bug with the Checkbox component where validation messages wouldn't be positioned correctly.

• #768 0270f06d Thanks @danielguillan! - Improves spacing of RiverBreakout content

• #797 b3e34be5 Thanks @rezrah! - Fixed visual bug in RiverStoryScroll layout on narrow viewports. Also adjusted positioning of the pagination to be closer to the scrolled items.

• #760 6be1118d Thanks @joshfarrant! - Fixed a bug where passing a className to Hero.Label or Hero.Eyebrow would replace the default class.

• #766 d10dc535 Thanks @danielguillan! - Adds internal paddings to River content on larger viewports

• #767 299ad371 Thanks @danielguillan! - - Update the order of River children to ensure an accessible markup structure.

  • On narrow viewports, the content and visuals are now flipped, with the visuals always placed first to enhance visual hierarchy.

    ⚠️ This may introduce a visual breaking change, whereby the visual is now displayed earlier in the page than originally intended. Please manually review content adjacent to the River components for correctness.

• #785 ec7d4023 Thanks @joshfarrant! - Fixed bug in Card component which caused the focus outline to not display when in dark-mode

@primer/[email protected]

@primer/[email protected]

@primer/[email protected]

@primer/[email protected]

[github-actions]

❗ Pre-merge checklist

Please ensure these items are checked before merging.

✅ Preliminary checks

• All CI checks pass on this pull request
• Docs and Storybook previews open in a browser

🔌 Integration smoke tests

Dotcom

• Performed successful integration test with github/github, as a primary consumer of Primer Brand
  • Install RC: bin/npm install --save --save-exact @primer/react-brand@{RC_VERSION}
    Important: Verify that each workspace package has been updated correctly in their respective package.json files
  • Run development server
  • Manually verify release-specific bugfixes and/or features on the following pages:
    • /features/copilot
    • /enterprise
    • /enterprise/advanced-security
    • /articles/security
    • /articles/security/what-is-security-testing
    • /features/preview
    • /features/copilot/getting-started and /features/copilot
    • /solutions/devops
    • /education
    • /mobile
    • /contact-sales
    • /about/diversity
  • Manually compare production site to local instance for any non-release specific regressions

Subdomain sites

• Performed successful integration test with githubuniverse.com, as a Tier 1 consumer of Primer Brand outside of the monolith.

  • Run development server and verify no new console warnings or regressions are found
  • Run local build to verify the release compiles correctly
  • Manually performed side-by-side comparison with production

• Performed successful integration test with https://resources.github.com/, as a Tier 1 consumer of Primer Brand outside of the monolith.

  • Run development server and verify no new console warnings or regressions are found
  • Run local build to verify the release compiles correctly
  • Manually performed side-by-side comparison with production

Sandboxes

• Works in CodeSandbox or StackBlitz
  • New components render successfully
  • (optional) Tested in both SPA and SSR apps if release contains build changes

🤔 Cross-check (aka sanity test)

• Release notes accurately describe the changes made
• All bugfixes in this release have resolved their corresponding issues
• The issues for reverted PRs have been re-opened and commented on with a link to the reverted PR
• No noticeable regressions or side-effects have not been introduced as a result of changes in this release.
  • If they have, determine severity of the issue and consider hotfixing

After tests

• Add report summary of your findings, including any images. Use following template as a guide:

  #### Smoke test results
  
  - Feature 1 🟢 🟡 🔴 (choose one, depending on success levels)
  
    {insert screenshot}
  
  Release testing status: Ready to release 🟢 | Paused 🟡 🔴 (choose one and provide reason)

🚢 After merge

• Issue release comms in primer brand Slack channel
• Add the preview deployment's link to releases as a way of permalinking to old version's docs. Example

[github-actions]

🟢 No design token changes found

[github-actions]

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

[rezrah]

Smoke test results

• Accessibility improvements to the FormControl.Hint component.

  Non-blocking regression in Storybook fixture, which was introduced in this PR.

  Screen.Recording.2024-10-28.at.10.01.27.mov

  Release testing status: Ready to release 🟢 (⚠️ we need to follow up on the above ☝️)

• Increased spacing between River components on narrow viewports from 28px to 36px

  Verified in dotcom

  

  Release testing status: Ready to release 🟢

• Added aria-describedby attribute to leading/trailing text and visuals in TextInput component

  Verified in dotcom, id correctly being applied to visuals/texts

  Release testing status: Ready to release 🟢

• Fixed a bug where passing a className to Hero.Label or Hero.Eyebrow would replace the default class.

  Regression observed on Copilot feature page. Likely related to this PR. Caused by end-user overrides, which are no longer compatible with the latest release. We'll need to reach out to Brand Eng to on remediation steps.

  

  Release testing status: Paused 🟡

• Button component would reflow and break over multiple lines

  Vertical padding regression observed on buttons with reflow. Likely due to removal of vertical padding in this PR.

  

  Release testing status: Ready to release 🟡 (Potentially non-blocking as reflow wasn't supported previously. We should remediate in follow up PR however.)

• Adds internal paddings to River content on larger viewports

  1 unflagged visual breaking change and 1 regression observed on various River instances.

  Before	After

  Ordering has changed on the page, but isn't flagged in the change log.

  Before	After

  Release testing status: Paused 🔴

• Add Icon component with new color primitives.

  Not exported from the package contrary to the change log entry.

  We need to either remove the entry and mark as a private component, or add the export to the root of the package.

  Release testing status: Paused 🔴

• Fixed visual bug in RiverStoryScroll

  Screen.Recording.2024-10-28.at.12.34.19.mov

  Verified in dotcom.

  Release testing status: Ready to release 🟢

[rezrah]

Smoke test results (2nd round)

• Add Icon component with new color primitives.

  Previous issue resolved by removing changelog entry and keeping the component internal-only.

  Ready to release 🟢

• Adds internal paddings to River content on larger viewports

  Previous issue resolved by applying paddings from large breakpoints only via this hotfix

  Ready to release 🟢

• Button component would reflow and break over multiple lines

  Resolved in this hotfix. Vertical padding restored.

  Ready to release 🟢

Release good to go 🚀