chore: workflow documentation cleanup

caseyisonit commented 2 weeks ago

We are starting to annotate our GitHub workflows and tasks so they are self-documented and easier to understand what is happening in them.

Motivation and context

These files are not touched often and are pretty complex in their setup and abstractions.
Since we are open source, our repo should be heavily self-documented for the ease of contributors and ourselves
update our linter to be current

How has this been tested?

[ ] Tests pass as expected
1. This PR passes all expected tests (CircleCi still is flaky)
2. CircleCi Lint is passing

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)
[x] Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

[x] I have signed the Adobe Open Source CLA.
[x] My code follows the code style of this project.
[x] If my change required a change to the documentation, I have updated the documentation in this pull request.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[x] 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.

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 11854062488

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.195%

Totals
Change from base Build 11795977313:	-0.002%
Covered Lines:	32328
Relevant Lines:	32745

💛 - Coveralls

github-actions[bot] commented 2 weeks ago

Branch preview

github-actions[bot] commented 2 weeks ago

Tachometer results

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

github-actions[bot] commented 2 weeks ago

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](https://github.com/GoogleChrome/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.242 kB	236.469 kB 🏆	236.847 kB
Scripts	60.426 kB	54.211 kB 🏆	54.294 kB
Stylesheet	53.902 kB	47.803 kB 🏆	48.095 kB
Document	6.237 kB	5.507 kB	5.467 kB 🏆
Font	126.846 kB	126.597 kB 🏆	126.641 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

caseyisonit commented 2 weeks ago

@blunteshwar cleaned up and passing!

adobe / spectrum-web-components