[NT] Split out docs dependencies
#2084
Merged
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
timdawborn
changed the title
docs dependencies
timdawborn
commented
Oct 12, 2023
| @@ -32,15 +32,27 @@ commands: | |||
| - checkout | |||
| - restore_cache: | |||
| keys: | |||
| - v3-dependencies-{{ checksum "package.json" }} | |||
| - v3-dependencies-{{ checksum "yarn.lock" }} | |||
There was a problem hiding this comment.
Unrelated bug fix — the node_modules cache should have been keyed by yarn.lock, not package.json.
timdawborn
commented
Oct 12, 2023
Comment on lines
+44
to
+55
| - restore_cache: | ||
| keys: | ||
| - v3-docs-dependencies-{{ checksum "docs/yarn.lock" }} | ||
| - v3-docs-dependencies | ||
| - run: | ||
| name: Install docs dependencies | ||
| command: yarn install --frozen-lockfile | ||
| working_directory: docs/ | ||
| - save_cache: | ||
| paths: | ||
| - docs/node_modules | ||
| key: v3-docs-dependencies-{{ checksum "docs/yarn.lock" }} |
There was a problem hiding this comment.
Install the docs dependencies in addition to the top-level dependencies.
timdawborn
commented
Oct 12, 2023
Comment on lines
+12
to
+17
| - package-ecosystem: npm | ||
| directory: "/docs" | ||
| schedule: | ||
| interval: weekly | ||
| day: monday | ||
| time: "05:00" |
There was a problem hiding this comment.
Add dependabot updates for the docs dependencies.
timdawborn
commented
Oct 12, 2023
Comment on lines
+80
to
+87
| - run: | ||
| name: Build the documentation. | ||
| command: | | ||
| set -uex | ||
| if [ << parameters.node_version >> -gt 16 ]; then | ||
| # Without this, we get `Error: error:0308010C:digital envelope routines::unsupported` on Node >= 17. | ||
| export NODE_OPTIONS="--openssl-legacy-provider" | ||
| fi |
There was a problem hiding this comment.
Build the docs as part of CI.
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.
Description, Motivation and Context
The dependencies in the top-level
package.jsonfile are not particularly representative of SPOT itself. Many of them, especially the large external libraries (including mobx and react 😱), are only needed for building the docs.This PR moves all of the docs-only dependencies out to their own
package.jsonandyarn.lockfiles. By having the docs dependencies separate, we should have a lot more confidence when upgrading external dependencies that we're not going to break the main application.