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

• #896 ce6c8b6 Thanks @rezrah! - Updated minimum, compatible version of react and react-dom to v18

Patch Changes

• #896 ce6c8b6 Thanks @rezrah! - Updated leadingVisual prop in Label to accept Icon children from the @primer/octicons-react package.

• #896 ce6c8b6 Thanks @rezrah! - Replaced usage of @reach/auto-id with native useId in react@v18

• #896 ce6c8b6 Thanks @rezrah! - Add peerDependenciesMeta configuration, preventing unnecessary peer dependency warnings

• #899 bc24d7a Thanks @joshfarrant! - Added a scroll margin to Footnote.Item to prevent it from being hidden behind fixed navigation during automatic scrolling.

• #897 1c47b76 Thanks @joshfarrant! - IDE component accessibility improvements

  • Added 1px border to identify active tab and start/end of Copilot suggestion. The colours of these borders can be customised via the --brand-IDE-default-editor-tab-borderColor and --brand-IDE-autoSuggest-borderColor CSS variables.
  • Added horizontal scrolling to IDE component when viewed on small viewports

@primer/[email protected]

@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
    • /features/copilot/getting-started
    • /features/preview
    • /enterprise
    • /enterprise/advanced-security
    • /enterprise/contact
    • /articles/security
    • /articles/security/what-is-security-testing
    • /solutions/devops
    • /education
    • /mobile
    • /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.

[joshfarrant]

Smoke test results

• React version change and peerDependencies update 🟢
  No issues found when installing or building in any environment

• @reach/auto-id removal 🟢
  Tested various components which relied on this hook in dotcom and all continue to function correctly

• Label leadingVisual prop 🟢
  Verified to be working in dotcom, docs, Storybook, and StackBlitz
  

• IDE component accessibility improvements 🟢
  Verified to be working in dotcom, docs, Storybook, and StackBlitz
  

• Footnote.Item scroll margin 🟢
  Verified to be working in dotcom, docs, Storybook, and StackBlitz. In demo video below, first test is using the release candidate, second is production dotcom. Note how in the first example the 2 Footnote Item is not hidden behind the nav after the scroll, whereas in the second example it is.

footnote-scroll.mp4

Release testing status: Ready to release 🟢