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 #888

Merged
merged 1 commit into from
Jan 17, 2025
Merged

Release tracking #888

merged 1 commit into from
Jan 17, 2025

Conversation

primer-css
Copy link
Contributor

@primer-css primer-css commented Jan 10, 2025

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/brand-primitives@0.46.0

Minor Changes

  • #893 d3c1ee2a Thanks @rezrah! - Updated secondary Button variant borders from subtle to default color for improved contrast.

Patch Changes

  • #883 965a7865 Thanks @rezrah! - Added new token for river breakout vertical spacing:

    --brand-River-spacing-innerY
    
  • #879 4f92311f Thanks @rezrah! - Added new accordion toggle color variables

    --brand-Accordion-toggle-color-default;
    --brand-Accordion-toggle-color-blue;
    --brand-Accordion-toggle-color-blue-purple-start;
    --brand-Accordion-toggle-color-blue-purple-end;
    --brand-Accordion-toggle-color-coral;
    --brand-Accordion-toggle-color-green;
    --brand-Accordion-toggle-color-green-blue-start;
    --brand-Accordion-toggle-color-green-blue-end;
    --brand-Accordion-toggle-color-gray;
    --brand-Accordion-toggle-color-indigo;
    --brand-Accordion-toggle-color-lemon;
    --brand-Accordion-toggle-color-lime;
    --brand-Accordion-toggle-color-orange;
    --brand-Accordion-toggle-color-pink;
    --brand-Accordion-toggle-color-pink-blue-start;
    --brand-Accordion-toggle-color-pink-blue-end;
    --brand-Accordion-toggle-color-purple;
    --brand-Accordion-toggle-color-purple-red-start;
    --brand-Accordion-toggle-color-purple-red-end;
    --brand-Accordion-toggle-color-red;
    --brand-Accordion-toggle-color-red-orange-start;
    --brand-Accordion-toggle-color-red-orange-end;
    --brand-Accordion-toggle-color-teal;
    --brand-Accordion-toggle-color-yellow;
    

@primer/react-brand@0.46.0

Minor Changes

  • #884 bbdf7f2f Thanks @rezrah! - Anti-aliasing is now applied automatically to all Text instances except under these conditions:

    • When explicitly disabled via hasAntiAliasing={false}
    • When font weight is light or extralight AND size is '100' or '200'
    • When size is 100 (regardless of weight)
  • #893 d3c1ee2a Thanks @rezrah! - Updated secondary Button variant borders from subtle to default color for improved contrast.

  • #890 4692aeea Thanks @joshfarrant! - Enabled keyboard navigation in the IDE component and made the contents navigable by screen readers.

    ⚠️ Breaking changes

    The alternativeText prop on the IDE component has been removed in favour of more granular descriptive text.

    Before
    <IDE alternativeText="A user asks how to concatenate arrays in JavaScript, Copilot demonstrates using the concat method, and the user confirms it worked.">
      <IDE.Chat />
    </IDE>
    After
    <IDE>
      <IDE.Chat alternativeText="A user asks how to concatenate arrays in JavaScript, Copilot demonstrates using the concat method, and the user confirms it worked." />
    </IDE>
    Before
    <IDE alternativeText="TypeScript sentiment analysis function with D3.js visualization.">
      <IDE.Editor
        files={[
          {
            name: 'index.js',
          },
        ]}
      />
    </IDE>
    After
    <IDE>
      <IDE.Editor
        files={[
          {
            name: 'index.js',
            alternativeText: 'TypeScript sentiment analysis function with D3.js visualization.',
            // ...
          },
        ]}
      />
    </IDE>

    🔗 See the documentation for example usage, and more information on accessibility in the IDE component

Patch Changes

  • #887 8a49db27 Thanks @joshfarrant! - Link component improvements.

    • Fixed a bug in the Link component where the underline wouldn't take the full width when arrowDirection='none'.
    • Prop options are also now exported from the package root, specifically:
      • LinkSizes
      • LinkArrowDirections
  • #879 4f92311f Thanks @rezrah! - Added toggleColor prop to FAQ.Question and Accordion.Heading

    <FAQ>
      <FAQ.Item>
        <FAQ.Question toggleColor="green-blue">...</FAQ.Question>
        <FAQ.Answer>...</FAQ.Answer>
      </FAQ.Item>
    </FAQ>
    <Accordion>
      <Accordion.Heading toggleColor="green-blue">...</Accordion.Heading>
      <Accordion.Content>...</Accordion.Content>
    </Accordion>

    🔗 See the documentation for examples and color options

  • #894 aecc8d8f Thanks @rezrah! - Improvements to duotone text in River component. Now supports <b> elements using a semi-bold font weight.

    🔗 See documentation for usage examples

  • #892 e85c7316 Thanks @rezrah! - Upgraded dev dependencies for @types/node and eslint-plugin-github

  • #883 965a7865 Thanks @rezrah! - Visual spacing updates to RiverBreakout

    • Reduced vertical gap between the main text and link.
    • Applied a maximum width to the main text.
  • #872 872bdcf0 Thanks @joshfarrant! - VideoPlayer tooltips now show when the associated control receives focus.

@primer/brand-storybook@0.46.0

@primer/brand-e2e@0.46.0

@primer/brand-fonts@0.46.0

@primer/brand-config@0.46.0

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
      • /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

Copy link
Contributor

github-actions bot commented Jan 10, 2025

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Jan 10, 2025

🟢 No visual differences found

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

@rezrah
Copy link
Collaborator

rezrah commented Jan 17, 2025

Smoke test results

  • Updated secondary Button variant borders from subtle to default color for improved contrast. 🟢

    Works as expected. All non-overridden secondary buttons now use darker outlines.

    Before After

    Screenshot 2025-01-17 at 13 51 49

    Screenshot 2025-01-17 at 13 51 41

    Before After

    Screenshot 2025-01-17 at 13 51 17

    Screenshot 2025-01-17 at 13 51 21

  • Added new accordion toggle color variables 🟢

    Works as expected. Toggle colors in FAQs now accept color overrides

    E.g.
    Screenshot 2025-01-17 at 13 48 32

  • Visual spacing updates to RiverBreakout 🟢

    Works as expected. Breakout content now applies a max width and reduced spacing between paragraph and CTA

    Before After

    Screenshot 2025-01-17 at 13 57 20

    Screenshot 2025-01-17 at 13 57 15

  • Improvements to duotone text in River component 🟢

    Works as expected to documentation guidelines.

    E.g.

    Screenshot 2025-01-17 at 13 56 26

  • Anti-aliasing is now applied automatically to all Text instances 🟢

    Works as expected. Only applies in dark mode text instances. E.g.

    Screenshot 2025-01-17 at 14 57 20

    ⚠️ This is something to keep an eye on during further regression testing, due to previous rollbacks of AA. Recommend checking as many pages as possible for legibility issues.

Release testing status: Ready to release 🟢

@rezrah rezrah merged commit 0d9c9e7 into main Jan 17, 2025
18 checks passed
@rezrah rezrah deleted the changeset-release/main branch January 17, 2025 15:12
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