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

chore: simplify beta docs deployment steps #5026

Merged
merged 4 commits into from
Jan 24, 2025
Merged

Conversation

rubencarvalho
Copy link
Collaborator

@rubencarvalho rubencarvalho commented Jan 15, 2025

Description

With the introduction of Yarn 4, we need to update the build steps for deploying our documentation website in CI. This PR aligns the implementation with the changes already merged for deploying the documentation website and Storybook previews in each PR.

Motivation and context

Did you know? We automatically deploy a beta documentation website every time we merge to main.
You can visit it here: https://beta–spectrum-web-components.netlify.app/
Without this fix, the beta documentation website won’t be deployed.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

Copy link

changeset-bot bot commented Jan 15, 2025

⚠️ No Changeset found

Latest commit: 49d8abc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Copy link

Tachometer results

Currently, no packages are changed by this PR...

Copy link

github-actions bot commented Jan 15, 2025

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.99 0.99
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
What is this?

Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 250.13 kB 236.332 kB 236.329 kB 🏆
Scripts 60.361 kB 54.297 kB 54.221 kB 🏆
Stylesheet 53.849 kB 47.527 kB 🏆 47.639 kB
Document 6.241 kB 5.508 kB 5.499 kB 🏆
Font 126.839 kB 126.651 kB 126.623 kB 🏆

Request Count

Category Latest Main Branch
Total 52 52 52
Scripts 41 41 41
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

@coveralls
Copy link
Collaborator

coveralls commented Jan 15, 2025

Pull Request Test Coverage Report for Build 12946154850

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.002%) to 98.208%

Totals Coverage Status
Change from base Build 12906208419: -0.002%
Covered Lines: 33025
Relevant Lines: 33449

💛 - Coveralls

@rubencarvalho rubencarvalho marked this pull request as ready for review January 16, 2025 15:42
@rubencarvalho rubencarvalho requested review from a team as code owners January 16, 2025 15:42
@Rajdeepc Rajdeepc changed the title chore: fix beta docs deployment steps chore: simplify beta docs deployment steps Jan 23, 2025
@rubencarvalho rubencarvalho merged commit f26a46b into main Jan 24, 2025
23 of 27 checks passed
@rubencarvalho rubencarvalho deleted the ruben/fix-beta-docs branch January 24, 2025 13:04
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.

4 participants