Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release tracking #807

Merged
merged 1 commit into from
Nov 6, 2024
Merged

Release tracking #807

merged 1 commit into from
Nov 6, 2024

Conversation

primer-css
Copy link
Contributor

@primer-css primer-css commented Oct 31, 2024

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

  • #798 af335d37 Thanks @joshfarrant! - ⚠️ Breaking change: Removed all Card-icon-background/color tokens (eg --brand-Card-icon-background-blue, --brand-Card-icon-color-orange)

@primer/[email protected]

Minor Changes

  • #811 6331ae61 Thanks @rezrah! - River and SectionIntro link colors now default to blue (accent) for consistency with Card, Pillar and similar components that feature blue links.

    ⚠️ This is a visual breaking change. Please manually review all usages of River and SectionIntro to ensure there is sufficient contrast with the background color.

Patch Changes

  • #805 2928995b Thanks @rezrah! - Disabled all transitions and auto-staggering when reduced-motion user preference is enabled

  • #809 bbb14ce9 Thanks @rezrah! - Updated Link underline to fill entire width

  • #798 af335d37 Thanks @joshfarrant! - - Fixed a bug where the Bento leadingVisual prop wouldn't honour the provided size.

    • Updated the Card.Icon internal implementation to use the new Icon component.
  • #810 774b91b0 Thanks @rezrah! - Added new background customization options to CTABanner

    New props:

    • backgroundColor
    • backgroundImageSrc
    • backgroundImageSize
    • backgroundImagePosition

    Also added variant prop to CTABanner.Description, to achieve higher contrast when using background images.

    🔗 See the documentation for more details and usage examples.

  • #805 2928995b Thanks @rezrah! - Removed negative margin from RiverStoryScroll when reduced-motion user preference is enabled

@primer/[email protected]

@primer/[email protected]

@primer/[email protected]

@primer/[email protected]

Copy link
Contributor

❗ 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

Copy link
Contributor

github-actions bot commented Oct 31, 2024

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Oct 31, 2024

🟢 No visual differences found

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

@rezrah
Copy link
Collaborator

rezrah commented Nov 6, 2024

Smoke test results

  • Breaking change: Removed all Card-icon-background/color tokens 🟢

    • x2 regressions observed in dotcom

    • Copilot Extensions

      Before After
      Screenshot 2024-11-06 at 14 15 15 Screenshot 2024-11-06 at 14 15 18

      Will need Brand Eng to remediate. cc. @raytalks
      Size discrepancy fixable by adding size="medium here

    • Copilot page

      Before After
      Screenshot 2024-11-06 at 14 06 31 Screenshot 2024-11-06 at 14 06 39

      Will need Brand Eng to remediate. cc. @raytalks
      Fixable by updating this line, which is using a deprecated CSS variable.

      -   background-color: var(--brand-Card-icon-background-purple);
      +   background-color: var(--base-color-scale-purple-8);
  • River and SectionIntro link colors now default to blue 🟢

    Links without additional overrides now default to blue as expected. On many pages however, overrides prevent the link color from changing. This will need to be updated on case-by-case basis.

  • Updated Link underline to fill entire width 🟢

  • Updated the Card.Icon internal implementation to use the new Icon component 🟢

  • Disabled all transitions and auto-staggering when reduced-motion user preference is enabled 🟢

  • Added new background customization options to CTABanner 🔴

    Blocking regression on all CTA banner instances where a default color isn't specified

    Screenshot 2024-11-06 at 14 27 27

    Fallback value is not registering, due to malformed css in bundled output.

    Screenshot 2024-11-06 at 14 40 15

    Will require an investigation and hotfix ⚠️

Release testing status: Not ready for release 🔴

@rezrah
Copy link
Collaborator

rezrah commented Nov 6, 2024

Smoke test update:

Release testing status: Ready for release 🟢

@rezrah rezrah merged commit eb22cea into main Nov 6, 2024
18 of 19 checks passed
@rezrah rezrah deleted the changeset-release/main branch November 6, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants