upward-dev / Upward

open source project for the tech community - let's learn from each other
GNU General Public License v3.0
3 stars 4 forks source link

Fix Optional Typescript GitHub CI Check to Only Run on /^ts-*/ Branch Based PRs #14

Closed diffalot closed 3 years ago

diffalot commented 3 years ago

I've broken these commits out of the previous CI plus README notes, and I'm pretty confident that these aren't going to present any conflicts for PRs that are currently in flight.

Here's the main part of the README that will be coming up in a separate PR soon:

Typescript (completely optional)

Typescript is enabled throughout the project, and to opt in, create a working branch where the name of the branch begins with ts- or contains the word typescript (and capitalization matters for both of those).

Be forewarned that this process will require writing types for everyone who has elected to not write any types before a branch will pass tarn types:strict. So don't surprised, and don't go down this road unless you are specifically looking to practice a lot and overtrain to excel during interviews.

When you begin a branch name with ts-, the CI system will run yarn types:strict in addition to the other tests. Once the tests all pass, the merge button will be available.

For convenience during development, run yarn watch:types:strict and the the type checker will update the test results every time you save a file.