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

Merged
merged 1 commit into from
Aug 30, 2024
Merged

Release tracking #712

merged 1 commit into from
Aug 30, 2024

Conversation

primer-css
Copy link
Contributor

@primer-css primer-css commented Aug 22, 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/brand-primitives@0.39.0

Minor Changes

  • #717 24fc6d02 Thanks @rezrah! - Change to xxlarge breakpoint and the addition of two new base scale size tokens.

    Outcome of an upgrade to Primer Primitives v9 release.

    + --base-size-2: 0.125rem;
    + --base-size-6: 0.375rem;
    - --brand-breakpoint-xxlarge: 90rem;
    + --brand-breakpoint-xxlarge: 87.5rem;
    - @custom-media --brand-viewportRange-wide-viewport (min-width: 90rem);
    + @custom-media --brand-viewportRange-wide-viewport (min-width: 87.5rem);

@primer/react-brand@0.39.0

Minor Changes

  • #717 24fc6d02 Thanks @rezrah! - Improved a11y labelling in various components.

    Please note these changes could affect any behavioral tests, which rely on accessible matchers such as getByRole.

    • SubdomainNavBar search button aria-label changed from 'search' to 'Toggle search bar'
    • SubdomainNavBar removal of unnecessary aria-label 'global breadcrumb'
    • Checkbox addition of new label for checked state icon as 'Checkmark'
    • Checkbox addition of new label for indeterminate state icon as 'Dash icon'
  • #707 715dfbb3 Thanks @rezrah! - New Footnotes component generally available

    import {Footnotes} from '@primer/react-brand'
    <Footnotes>
      <Footnotes.Item>There are now 100 million developers around the world using GitHub.</Footnotes.Item>
    </Footnotes>

    🔗 Read the documentation for usage guidelines and examples

Patch Changes

  • #711 1cde8ef2 Thanks @joshfarrant! - Updated SubNav links and submenus to use ul and li elements — instead of div elements — to communicate the hierarchy of the navigation to assistive technologies.

  • #700 47908f1e Thanks @rezrah! - ActionMenu button no longer truncates longer labels. Now follows WCAG criterion around text reflow.

  • #714 fb1980b1 Thanks @rezrah! - Hide paged items in Pagination component on narrow viewports to prevent horizontal scrolling and offer improved accessibility by default.

    Use showPages to re-enable paged items if required:

    <Pagination showPages />

@primer/brand-storybook@0.39.0

@primer/brand-e2e@0.39.0

@primer/brand-fonts@0.39.0

@primer/brand-config@0.39.0

Copy link
Contributor

github-actions bot commented Aug 22, 2024

❗ 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 Aug 22, 2024

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Aug 22, 2024

🟢 No visual differences found

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

@rezrah
Copy link
Collaborator

rezrah commented Aug 30, 2024

Smoke test results

  • Footnotes component 🟢

    Works as expected. Confirmed as suitable replacement for adaptation of FAQ for similar purposes.

    Screenshot 2024-08-30 at 12 02 25

    Top is current. Below is replacement using Footnotes.

  • Aria label changes 🟢

    Verified to appear correctly in the DOM, but many components like Checkbox aren't in frequent use in dotcom right now. Manual integration confirmed it works as expected.

    Screenshot 2024-08-30 at 11 54 35

  • Pagination default behaviour 🟢

    Tested in dotcom on SEO category pages. Default behaviour works as expected. Paged items are now hidden by default
    Screenshot 2024-08-30 at 12 06 15

Release testing status: Ready to release 🟢

@rezrah rezrah merged commit 9048331 into main Aug 30, 2024
18 of 19 checks passed
@rezrah rezrah deleted the changeset-release/main branch August 30, 2024 11:10
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