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

• #684 e382a491 Thanks @danielguillan! - Extend Hero.Heading and Heading.Description length.

  Warning
  This change can lead to reduced contrast in certain situations. Please manually review all instances of the Hero - particularly those that use a background image - to ensure that minimum contrast requirements are met.

Patch Changes

• #695 2bb68ea7 Thanks @joshfarrant! - ComparisonTable featured columns now identify themselves to screen readers by appending the text featured to the column title. This text can be customized using the visuallyHiddenFeaturedLabel prop.

• #677 c76c8c87 Thanks @rezrah! - Removed redundant styles in default Section and BreakoutBanner components

• #688 55a353c7 Thanks @rezrah! - Added experimental TextRevealAnimation component.

• #688 55a353c7 Thanks @rezrah! - Remove strict, custom typings for Testimonial.Quote

• #679 30f717dd Thanks @joshfarrant! - Fixed an issue where SubNav submenus were not accessible through keyboard navigation

@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
    • /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 1 results: 08/14/2024

• Extend Hero.Heading and Heading.Description length 🟡

  • verified to work in dotcom
  • not tested outside dotcom yet

• Removed redundant styles in default Section and BreakoutBanner components 🟢

  • Verified to have been removed in dotcom
  • Doesn't need to be checked on subdomain sites

• Added experimental TextRevealAnimation component 🔴

  • Accessibility violation around heading text in dotcom
  • Requires hotfix
  • Release testing paused until this issue has been resolved

• Remove strict, custom typings for Testimonial.Quote

  • Verified to have been removed in dotcom
  • Doesn't need to be checked on subdomain sites

Release testing status: Paused 🔴

[rezrah]

Smoke test 2 results: 08/14/2024

Extend Hero.Heading and Heading.Description length 🟢

• Verified across multiple Tier 1 sites, working as expected. Visual regressions minimal and changes are well documented.

Removed redundant styles in default Section and BreakoutBanner components 🟢

• Verified as fixed in dotcom

Added experimental TextRevealAnimation component 🟢

• Earlier issue has been hotfixed

  

Fixed an issue where SubNav submenus were not accessible through keyboard navigation 🟢

• Verified as fixed in dotcom, which is the only place this is used

  Screen.Recording.2024-08-14.at.17.15.06.mov

CodeSandbox test complete 🟢

• All features work as expected on a clean installation

  Screen.Recording.2024-08-14.at.17.21.06.mov

Release testing status: Ready to release 🟢