chore(ci): run TypeDoc generation in Code Quality Checks action #4345
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Outdated file: `typedoc` is only a dependency of `website/`, and this file lacked the latest updates requried for recent typedoc compatibility.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/invertase/react-native-firebase/ngg1uqv9e |
mikehardy
reviewed
Oct 1, 2020
| id: yarn-cache | ||
| with: | ||
| path: ${{ steps.yarn-cache-dir-path.outputs.dir }} | ||
| key: ${{ runner.os }}-yarn-${{ hashFiles('**/package.json') }}-with-website |
There was a problem hiding this comment.
interesting I think if you just put the yarn-cache from checkout package.json doesn't have the full thing yet so that key won't be right. This seems like a fine workaround given that it's not in the workspace so not in package.json by default.
mikehardy
approved these changes
Oct 1, 2020
|
@Salakar the tradeoffs enumerated above are worth a second look I think - look good to me, but just in case... |
Salakar
approved these changes
Oct 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issues
Fixes #4321
Description
This PR adds TypeDoc generation in the Code Quality Checks action. In PR #4306, a typedoc failure was causing the Vercel deployment phase to fail, and those logs aren't public.
There were a few challenges that required decisions:
typedocis a dependency ofwebsite/, which is not part of the lerna/workspace, so its dependencies are not installed in current actions.Yarn Install (Website)stage, with the existing retry pattern.-with-website) since additional packages are installed. Not certain this is correct, so be sure to reviewtypedocas a root dependency, or do a one-offyarn add typedocin the CI actionscripts/generate-typedoc.jsscript that is no longer used. It did not receive the recent typedoc changes that thewebsite/scripts/generate-typedoc.jsfile did, so it is not currently functional.website/scripts/generate-typedoc.jsfile is not a callable script.node -e "require('./website/scripts/generate-typedoc').generateTypedoc()"scripts/generate-typedoc.jsfile as a callable script, or alter thewebsite/scripts/generate-typedoc.jsto be more flexibleThanks for reviewing!
Release Summary
N/A
Checklist
Android(N/A)iOS(N/A)e2etests added or updated inpackages/\*\*/e2e(N/A)jesttests added or updated inpackages/\*\*/__tests__(N/A)Test Plan
CI actions
https://github.com/invertase/react-native-firebase/pull/4345/checks?check_run_id=1196025300
Think
react-native-firebaseis great? Please consider supporting the project with any of the below:React Native FirebaseandInvertaseon Twitter