-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Upgrade all dependencies (including 11ty 2.0) #33
Open
Gaelan
wants to merge
10
commits into
cloud-gov:main
Choose a base branch
from
Gaelan:11ty-upgrade
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
The only backwards-incompatible change for us is the switch from browsersync to 11ty's own web server, which required a change in how the 404 page is provided.
This also requires adding a dependency on glob@8, as a workaround for a missing dependency in eleventy-plugin-svg-sprite.
The breaking changes are a dependency on Node 14 (Cloud.gov Pages defaults to Node 16 anyway) and a change in cache location which they note arguably isn't a breaking change at all.
The only breaking change relates to the "system" time zone, but we always specify utc.
We don't use either of the features with breaking changes.
The only breaking change is dropping Node 12 support; Cloud.gov Pages defaults to Node 16.
The only breaking change affecting the CLI is loss of glob support by default, which we don't use.
I'm not entirely sure why it was pinned to a specific version in the first place, but USWDS follows semver, so there should be no need.
Big jump! Version-by-version notes: 0.15.0 contains breaking changes related to Yarn, which we don't use. 0.16.0 changes the names of some internal packages used by non-standard scripts, and changes the behavior of imports with the `assert { type: 'json' }` syntax. Neither affects us. 0.17.0 affects esbuild's native rebuild, serve, and watch features. We don't use these, in favor of wrapping esbuild in chokidar. 0.18.0 affects TypeScript, which we don't use.
After this, the only thing `npm outdated` reports is glob, which we intentionally added in f4b9e86 to work around a bug.
@Gaelan I've fixed the |
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.
Changes proposed in this pull request:
I've split each major upgrade into a separate commit, then one
npm upgrade
at the end to catch all the minor upgrades. See individual commit messages for notes on the breaking changes in the various packages, but a few significant notes:404.html
. I don't have access to Cloud.gov Pages, so please double-check this doesn't affect 404 pages in production.glob
, but doesn't specify this dependency in its package.json. Previously it got away with it, presumably because 11ty itself depended on glob, but this isn't the case anymore. As a workaround, we add a dependency onglob@8
, the last version that works with eleventy-plugin-svg-sprite, which causes the correct version of glob to be present in node_modules. See May not play nicely with 11ty 2.0 patrickxchong/eleventy-plugin-svg-sprite#11 and Update to 11ty 2.0.1 11ta/11ta-template#52.security considerations
New versions always carry the risk of new bugs, but the risk should be fairly minor.