Skip to content
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

feat: add engines field to templates' package.json #7520

Merged
merged 1 commit into from Jun 1, 2022
Merged

feat: add engines field to templates' package.json #7520

merged 1 commit into from Jun 1, 2022

Conversation

johnnyreilly
Copy link
Contributor

@johnnyreilly johnnyreilly commented May 28, 2022

Pre-flight checklist

Motivation

See #7517 - having the engines explicitly stated in the package.json rather than a transitive dependency allows tooling like Oryx to install the required minimum node version. See also johnnyreilly/blog.johnnyreilly.com#228 and https://blog.johnnyreilly.com/2022/05/28/azure-static-web-apps-node-16-oryx

Test Plan

See the linked PR moving from failed builds to passing builds as this change is applied.

Test links

https://blog.johnnyreilly.com/2022/05/28/azure-static-web-apps-node-16-oryx

Related issues/PRs

See links above

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 28, 2022
@netlify
Copy link

netlify bot commented May 28, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit af297e3
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/62921e378ab4c200093e2b99
😎 Deploy Preview https://deploy-preview-7520--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 76 🟢 100 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 82 🟢 99 🟢 100 🟢 100 🟢 90 Report

@Josh-Cena Josh-Cena changed the title feat: add engines to templates - addresses #7517 feat: add engines field to templates' package.json May 28, 2022
@Josh-Cena Josh-Cena added the pr: polish This PR adds a very minor behavior improvement that users will enjoy. label May 28, 2022
Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

LGTM

Will wait for @slorber to merge

@slorber
Copy link
Collaborator

slorber commented Jun 1, 2022

LGTM thanks 👍

I thought maybe we could add it to our website too? Not sure it would be very useful, unlikely users will use Oryx with it 🤷‍♂️

@slorber slorber merged commit 338b819 into facebook:main Jun 1, 2022
@johnnyreilly
Copy link
Contributor Author

johnnyreilly commented Jun 1, 2022

I thought maybe we could add it to our website too?

Not a bad idea! As a general principle, I like packages directly declaring their needs in the package.json - ideally there's only one place where all build requirements are specified (as opposed to having a build fail due the requirements of dependencies or worse transitive dependencies)

valentine added a commit to valentine/docs.hackerspace.sg that referenced this pull request Mar 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: polish This PR adds a very minor behavior improvement that users will enjoy.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal: add engines to package.json website/template
4 participants