Skip to content
This repository was archived by the owner on Jan 11, 2023. It is now read-only.

fix: updated Remix framework info that was missing #836

Merged
merged 2 commits into from
Nov 10, 2022

Conversation

nickytonline
Copy link
Contributor

@nickytonline nickytonline commented Nov 9, 2022

🎉 Thanks for submitting a pull request! 🎉

Summary

Adds missing framework info for Remix.

Fixes #835
Relates to remix-run/remix#3104


For us to review and ship your PR efficiently, please perform the following steps:

  • Open a bug/issue before writing your code 🧑‍💻. This
    ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a
    typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
  • Read the contribution guidelines 📖. This ensures your code follows our style guide and
    passes our tests.
  • Update or add tests (if any source code was changed or added) 🧪
  • Update or add documentation (if features were changed or added) 📝
  • Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

a cure alpaca

Sorry, something went wrong.

@netlify
Copy link

netlify bot commented Nov 9, 2022

Deploy Preview for framework-info ready!

Name Link
🔨 Latest commit 78370ba
🔍 Latest deploy log https://app.netlify.com/sites/framework-info/deploys/636d1bfc3ab694000960e647
😎 Deploy Preview https://deploy-preview-836--framework-info.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 github-actions bot added the type: bug code to address defects in shipped code label Nov 9, 2022
@@ -3,12 +3,14 @@
"name": "Remix",
"category": "static_site_generator",
"detect": {
"npmDependencies": ["remix", "@remix-run/netlify"],
"npmDependencies": ["remix", "@remix-run/netlify", "@remix-run/netlify-edge"],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

"@remix-run/netlify-edge" does not exist yet, but it will soon.

Copy link
Contributor Author

@nickytonline nickytonline Nov 9, 2022

Choose a reason for hiding this comment

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

Actually, quick question about npmDependencies. It means it needs to include all of them correct? So since we'll have a netlify-edge dep soon, should I create a remix-edge.json or just have npmDependencies contain only remix?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, so in the ReadME, I confirmed that only one of them needs to be present to be considered the framework. https://github.com/netlify/framework-info#npmdependencies

npmDependencies
Type: string[]

Framework's npm packages. Any project with one of those packages in their package.json (dependencies or devDependencies) will be considered as using the framework.

If empty, this is ignored.

@nickytonline nickytonline self-assigned this Nov 9, 2022
Copy link
Contributor

@ascorbic ascorbic left a comment

Choose a reason for hiding this comment

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

I don't know if/where this is documented, but this must not have a port set

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@kodiakhq kodiakhq bot merged commit e594ddf into main Nov 10, 2022
@kodiakhq kodiakhq bot deleted the nickytonline/update-remix-framework-info branch November 10, 2022 15:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
automerge type: bug code to address defects in shipped code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing framework info for Remix
2 participants