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 gulp use by extracting dev & watch #2099

Merged
merged 3 commits into from
Aug 22, 2023

Conversation

castastrophe
Copy link
Collaborator

@castastrophe castastrophe commented Aug 16, 2023

Description

  • Update dependencies from beta tags to latest in actionbar and divider
  • Create a single gulpfile.js at root that handles building & spinning up the dev server for the current documentation site
    • Add an environment variable for the localhost URL to storybook for dev runs
  • Remove bundle-builder
  • Update build commands to use NX and run build in parallel across components (based on dependencies defined)
  • Remove docs building from component builders

How and where has this been tested?

  • yarn build:all: Builds components, site, and storybook
  • yarn build:components: Builds components in parallel; uses cache [@mlogsdon18]
  • yarn build:preview: Builds storybook & dependencies (all components) [@mlogsdon18]
  • yarn build:site: Builds the website only [@mlogsdon18]
  • yarn ci:storybook: No regressions [@mlogsdon18]
  • yarn clean:components: Deletes compiled assets for all component folders [@mlogsdon18]
  • yarn clean:preview: Deletes the storybook compiled assets [@mlogsdon18]
  • yarn dev: Builds components & spins up live storybook & site; triggers component and assets watching [@mlogsdon18]
  • yarn lint: Lints packages and css for components [@mlogsdon18]
  • yarn start: Triggers storybook build and dev server [@mlogsdon18]

New commands

  • yarn release: builds components and runs lerna publish --no-private
  • yarn release:beta: builds components and lerna publish from-package --no-private --conventional-prerelease --preid beta --pre-dist-tag beta
  • yarn release:from-package: builds components and lerna publish from-package --no-private
  • yarn release:site: builds components, site, and storybook; publishes to gh-pages

Regression testing

Validate:

  1. A legacy documentation page (such as accordion), including:
  • The page renders correctly
  • The page is accessible
  • The page is responsive
  1. A migrated documentation page (such as action group), including:
  • The page renders correctly
  • The page is accessible
  • The page is responsive

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@castastrophe castastrophe force-pushed the chore-simplify-docs-build-gulp branch 3 times, most recently from 6dd0086 to bb6fb8e Compare August 16, 2023 20:55
@github-actions
Copy link
Contributor

github-actions bot commented Aug 16, 2023

🚀 Deployed on https://pr-2099--spectrum-css.netlify.app

@github-actions github-actions bot temporarily deployed to pull request August 16, 2023 21:00 Inactive
@castastrophe castastrophe added the build Issues associated with the build process; often a refactor label Aug 17, 2023
@castastrophe castastrophe added the run_vrt For use on PRs looking to kick off VRT label Aug 18, 2023
@github-actions github-actions bot temporarily deployed to pull request August 18, 2023 14:01 Inactive
@github-actions github-actions bot removed the run_vrt For use on PRs looking to kick off VRT label Aug 18, 2023
@castastrophe castastrophe added the run_vrt For use on PRs looking to kick off VRT label Aug 18, 2023
@github-actions github-actions bot temporarily deployed to pull request August 18, 2023 14:29 Inactive
@github-actions github-actions bot removed the run_vrt For use on PRs looking to kick off VRT label Aug 18, 2023
@castastrophe castastrophe force-pushed the chore-simplify-docs-build-gulp branch 2 times, most recently from 30b3615 to 926383b Compare August 18, 2023 15:19
@castastrophe castastrophe removed the request for review from jawinn August 18, 2023 15:20
@github-actions github-actions bot temporarily deployed to pull request August 18, 2023 15:28 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 18, 2023 15:42 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 18, 2023 19:37 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 21, 2023 13:48 Inactive
@castastrophe castastrophe force-pushed the chore-simplify-docs-build-gulp branch 2 times, most recently from 00e4866 to faf6020 Compare August 21, 2023 15:30
Copy link
Collaborator

@pfulton pfulton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things here, @castastrophe, but I think we're very close!

package.json Show resolved Hide resolved
package.json Show resolved Hide resolved
package.json Show resolved Hide resolved
package.json Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 19:05 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 19:19 Inactive
@castastrophe castastrophe force-pushed the chore-simplify-docs-build-gulp branch 2 times, most recently from 984fc9f to b506954 Compare August 22, 2023 20:05
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 20:10 Inactive
@castastrophe castastrophe force-pushed the chore-simplify-docs-build-gulp branch 3 times, most recently from 29dc7b1 to 20cddc5 Compare August 22, 2023 20:15
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 20:22 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 20:52 Inactive
@castastrophe castastrophe added the run_vrt For use on PRs looking to kick off VRT label Aug 22, 2023
@castastrophe castastrophe enabled auto-merge (squash) August 22, 2023 21:00
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 21:03 Inactive
@github-actions github-actions bot removed the run_vrt For use on PRs looking to kick off VRT label Aug 22, 2023
@castastrophe castastrophe merged commit 79748d6 into main Aug 22, 2023
6 of 7 checks passed
@castastrophe castastrophe deleted the chore-simplify-docs-build-gulp branch August 22, 2023 21:09
castastrophe added a commit that referenced this pull request Aug 23, 2023
castastrophe added a commit that referenced this pull request Aug 23, 2023
@github-actions github-actions bot mentioned this pull request May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues associated with the build process; often a refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants