-
Notifications
You must be signed in to change notification settings - Fork 235
chore: publish script fix for documentation #5882
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
Conversation
|
📚 Branch Preview🔍 Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
|
@Rajdeepc The changes look good to me, and follow the patterns established in other scripts/commands. Is there anyway you want me to validate and/or test the changes? (apart from just merging to main?) |
You can generate the CEM artifacts from the build steps on this file and see if you are getting errors or not. |
caseyisonit
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When this merges make sure it’s a chore not a fix in the message since this doesn’t require a changeset
marissahuysentruyt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Validated by running changed commands as seen in publish-docs-site.yml:
yarn workspace @spectrum-web-components/1st-gen docs:analyze
cp 1st-gen/projects/documentation/custom-elements.json 1st-gen/storybook/
yarn workspace @spectrum-web-components/1st-gen docs:production
yarn workspace @spectrum-web-components/1st-gen storybook:build
We’re currently not following conventional commit lint messaging, so this won’t appear in the changelog. However, I’ve updated it to chore for consistency. |
Description
Fixes the GitHub Actions workflow for publishing documentation by adding the
1st-gen/prefix to all file paths, resolving the "file not found" error during CI builds.Root Cause
The workflow's file operations (cp, output redirection, gh-pages deployment) were using paths without the
1st-gen/prefix, while:1st-gen/projects/documentation/custom-elements.json1st-gen/projects/documentation/dist/1st-gen/storybook/custom-elements.jsonChanges
Validation
Locally verified that the corrected paths work:
1st-gen/projects/documentation/custom-elements.json1st-gen/storybook/custom-elements.jsonMotivation and context
The documentation site publishing workflow was failing in CI with:
This occurred because after the monorepo restructuring, all 1st-gen package files are located under the
1st-gen/directory, but the workflow was still using the old root-level paths.Related issue(s)
Screenshots (if appropriate)
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Descriptive Test Statement
Descriptive Test Statement
Device review