Skip to content

Conversation

@castastrophe
Copy link
Contributor

@castastrophe castastrophe commented Mar 19, 2025

Description

Due to some spottiness and difficulty throughout the team debugging CircleCI, this pull request migrations a few low-impact tasks to GitHub Actions using a format that is already validated to be working in Spectrum CSS.

  • Move linting from CircleCI to being run and tracked via GitHub Actions
  • Add CI caching support via a key: OS + node version + yarn lockfile hash
    • leveraging these local caches has been shown to speed up CI runs significantly
  • New build workflow to validate the build steps continue to work in all supported development environments: MacOS, Linux, and Windows. This also ensures no uncommitted changes arise from the build task.
  • A single pull-request entry-point development.yml that runs on pull requests and pushes. It validates the build in each supported env, checks test coverage, and runs linting.
  • A new lint workflow built off the linting previous done in CircleCI plus the tooling leveraged current in the Spectrum CSS project.

How has this been tested?

Setup:

  • Create a fork branch off this one: git checkout -b test-circleci-migration

  • Validate stylelint plugin

    • Update packages/accordion/src/accordion.css with :host { --spectrum-logical-rotation: ; --spectrum-logical-rotation: ; } (duplicate variable intentional)
    • Commit this update without verifying (it will get blocked in precommit checks otherwise and we want to validate the reviewdog task): git commit --no-verify -m "break styles"
  • Validate eslint plugin

    • Update packages/accordion/src/Accordion.ts with import { css, CSSResultArray, html, PropertyValues, SizedMixin, SpectrumElement, TemplateResult, } from '@spectrum-web-components/base';
    • Commit this update without verifying (it will get blocked in precommit checks otherwise and we want to validate the reviewdog task): git commit --no-verify -m "break typescript"

To validate the above, open a pull request for the test branch update against main and let CI do its thing.

Expect a comment to be added to the pull request reporting the errors in this update

Types of changes

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

@changeset-bot
Copy link

changeset-bot bot commented Mar 19, 2025

⚠️ No Changeset found

Latest commit: 3363b2a

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 19, 2025

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.

@github-actions
Copy link
Contributor

Tachometer results

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

@coveralls
Copy link
Collaborator

coveralls commented Mar 19, 2025

Pull Request Test Coverage Report for Build 14133318326

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.999%

Totals Coverage Status
Change from base Build 14133083721: 0.0%
Covered Lines: 33711
Relevant Lines: 34211

💛 - Coveralls

@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch 8 times, most recently from 66d98a6 to 58e620f Compare March 20, 2025 00:49
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch 7 times, most recently from 5b787ac to 3b647fc Compare March 20, 2025 03:37
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch from 3b647fc to 8c5b757 Compare March 20, 2025 19:38
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch 15 times, most recently from 9a4bad9 to ece6ce1 Compare May 7, 2025 21:00
@castastrophe castastrophe added the Status: Ready for review PR ready for review or re-review. label May 7, 2025
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch 5 times, most recently from 587188a to 9579b34 Compare May 12, 2025 15:20
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch from 9579b34 to a1497f9 Compare May 16, 2025 17:07
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch 2 times, most recently from 1743afb to f7eb6b8 Compare June 19, 2025 13:23
@castastrophe castastrophe force-pushed the chore-migrate-lint-github-from-circleci branch from f7eb6b8 to 3363b2a Compare June 23, 2025 20:03
@castastrophe castastrophe removed the Status: Ready for review PR ready for review or re-review. label Jun 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Tooling Issue or PR dealing with scripts, workflows, automation, etc. Component prefix is for Jira github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants