Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Split CI into discrete jobs #981

Merged
merged 8 commits into from
Feb 22, 2022
Merged

Split CI into discrete jobs #981

merged 8 commits into from
Feb 22, 2022

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes #890 by @sarayourfriend

Description

Adds a new setup-node-env composite action to make node and pnpm installation more DRY.

Splits unit tests, e2e test, storybook build, nuxt build, linting, i18n verification, and type checking into discrete jobs in the CI so that they all run at the same time.

Testing Instructions

Check that the CI is running as expected compared to the behavior described in the yaml files.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Feb 21, 2022
@sarayourfriend sarayourfriend requested a review from a team as a code owner February 21, 2022 19:09
@dhruvkb
Copy link
Member

dhruvkb commented Feb 21, 2022

We moved the API repostory in the opposite direction, moving all separate jobs into a comprehensive CI + CD workflow (example run) that builds images, lints, runs tests, publishes images to GHCR and also deploys docs to GH pages. I believe that a comprehensive workflow is better than many separate ones because

  • it's easier to share artifacts and environments
  • you can visualise the entire process from the Actions diagram
  • it's also concurrent (jobs that don't depend on each other will run in parallel even in the same workflow)

@sarayourfriend
Copy link
Contributor Author

@dhruvkb Gotcha. I mostly just wanted to split each of the discrete tasks into their own jobs. I've pushed them into a single workflow now.

@sarayourfriend
Copy link
Contributor Author

One disadvantage to putting everything into the same workflow is that you can't re-run discrete parts of it, you have to re-run every single check. I guess it doesn't cost anything to us really, it just always bugs me!

"prettier --write"
],
"*.mdx": [
"*.{ts,js,vue,json,yml,yaml,mdx}": [
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice addition!

@sarayourfriend sarayourfriend merged commit 5b24e6f into main Feb 22, 2022
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

LGTM. One non-blocking question, would there be any benefit to checking lint errors prior to types? I think it's probably even better the way it is but i thought of the question and thought I'd pose it.

@sarayourfriend sarayourfriend deleted the add/split-ci branch February 22, 2022 20:10
obulat added a commit that referenced this pull request Feb 23, 2022
* Rename AudioDetails (#892)

* Rename AudioDetails folder

* Fix store access

* Revert conversion to Composition API

* Revert conversion to defineComponent

* Update pot

* Use v-show instead of v-if for width-based condition (#884)

* Use v-show instead of v-if for width-based condition

Use v-show instead of v-if to fix server-client mismatch

* Fix waveform not loading on SSR

* Split CI into discrete jobs (#981)

* Split CI into discrete jobs

* Update outdated POT file

* Skip writing POT file if the only thing changing is the date

* Format yaml

* Add yaml to lint staged

* Get locales when setting up node env

* Cram it all into a single workflow

* Add getting translations

* Update license explanation tooltip (#850)

Co-authored-by: Zack Krida <zackkrida@pm.me>
Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Fix attribution HTML glyph reference and fix historical usages as well (#990)

* Fix attribution HTML glyph reference and fix historical usages as well

* Add missing license parts

* Add note to explain directory structure

* Refactor media services (#867)

* Create a single media-service data fetching object

* Move slug creation from media service to the api service

* Use typing data from #868

* Update src/constants/media.js

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* edit api-service styles; format

* fix decode-media-data type import

* Return decoded data from the media services

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Make active media setup store and add unit tests

* Commit the lock file

* Fix merge problems

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
Co-authored-by: Dhruv Bhanushali <dhruv_b@live.com>
Co-authored-by: Zack Krida <zackkrida@pm.me>
obulat added a commit that referenced this pull request Mar 3, 2022
* Install Pinia

* Update the active media store to use Pinia

* Delete the Vuex store

* Update type definition and use it

* Document the store composition variable

* Fix a lint error that Prettier did not catch locally

* Use `~` instead of `@` in imports

* Update the nav store to use Pinia

* Rename store

* Make mutation payload fields non-nullable

* Fix leftover incorrect usage of the active media store

* Make active media setup store and add unit tests (#997)

* Rename AudioDetails (#892)

* Rename AudioDetails folder

* Fix store access

* Revert conversion to Composition API

* Revert conversion to defineComponent

* Update pot

* Use v-show instead of v-if for width-based condition (#884)

* Use v-show instead of v-if for width-based condition

Use v-show instead of v-if to fix server-client mismatch

* Fix waveform not loading on SSR

* Split CI into discrete jobs (#981)

* Split CI into discrete jobs

* Update outdated POT file

* Skip writing POT file if the only thing changing is the date

* Format yaml

* Add yaml to lint staged

* Get locales when setting up node env

* Cram it all into a single workflow

* Add getting translations

* Update license explanation tooltip (#850)

Co-authored-by: Zack Krida <zackkrida@pm.me>
Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Fix attribution HTML glyph reference and fix historical usages as well (#990)

* Fix attribution HTML glyph reference and fix historical usages as well

* Add missing license parts

* Add note to explain directory structure

* Refactor media services (#867)

* Create a single media-service data fetching object

* Move slug creation from media service to the api service

* Use typing data from #868

* Update src/constants/media.js

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* edit api-service styles; format

* fix decode-media-data type import

* Return decoded data from the media services

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Make active media setup store and add unit tests

* Commit the lock file

* Fix merge problems

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
Co-authored-by: Dhruv Bhanushali <dhruv_b@live.com>
Co-authored-by: Zack Krida <zackkrida@pm.me>

* fix possibly undefined

* Add tests and other small fixes

* Update nuxt.config.ts

Co-authored-by: Zack Krida <zackkrida@pm.me>

* Move converted modules to /stores/ and add unit tests

* Fix linting error

* Update nuxt.config.ts

Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>

* Add changes from review

* Register component

* Make properties readonly

* Remove dublicates

Co-authored-by: Olga Bulat <obulat@gmail.com>
Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
Co-authored-by: Zack Krida <zackkrida@pm.me>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split tests and static analysis into separate actions in the CI
4 participants