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(command-dev): add support for functionsPort flag fixes #3980 #4048

Merged
merged 3 commits into from Jan 19, 2022

Conversation

tinfoil-knight
Copy link
Contributor

@tinfoil-knight tinfoil-knight commented Jan 15, 2022

Summary

netlify dev already supports specifying the functionsPort setting used to set the port for functions server in netlify.toml.

Now, the functionsPort can now be specified through a command line flag too like:

netlify dev --functionsPort <port>

Fixes: #3980


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 βœ…

@tinfoil-knight tinfoil-knight requested a review from a team as a code owner January 15, 2022 17:23
@lukasholzer
Copy link
Collaborator

@tinfoil-knight thanks for taking the time to contribute to the CLI. Can you please reference the issue here that you are solving?

Just to get more background on the fix and to understand the problem

@tinfoil-knight
Copy link
Contributor Author

tinfoil-knight commented Jan 17, 2022

@lukasholzer The issue number is available in the title. I've also added it now to the description above now.

Issue Link: #3980

@tinfoil-knight
Copy link
Contributor Author

@lukasholzer While this issue adds a command line flag and documents it, I couldn't find the source repo for adding it to this page: docs.netlify.com/configure-builds/file-based-configuration/#netlify-dev which should ideally have the list of all supported options in netlify.toml

@lukasholzer
Copy link
Collaborator

@lukasholzer The issue number is available in the title. I've also added it now to the description above. Issue Link: #3980

Thx, sorry have not seen this inside the title πŸ€¦πŸ»β€β™‚οΈ – please always fill out the template correctly as GitHub auto detects words like Fixes #.... and automatically links the PR to the issue. This means if it is linked it gets automatically closed on merging the PR :)

@lukasholzer
Copy link
Collaborator

@lukasholzer While this issue adds a command line flag and documents it, I couldn't find the source repo for adding it to this page: docs.netlify.com/configure-builds/file-based-configuration/#netlify-dev which should ideally have the list of all supported options in netlify.toml

Yea this has to be documented in our private repository: https://github.com/netlify/docs but I can do this for you :)

@tinfoil-knight
Copy link
Contributor Author

tinfoil-knight commented Jan 17, 2022

Thx, sorry have not seen this inside the title πŸ€¦πŸ»β€β™‚οΈ – please always fill out the template correctly as GitHub auto detects words like Fixes #.... and automatically links the PR to the issue. This means if it is linked it gets automatically closed on merging the PR :)

My bad. Will remember from next time.

@lukasholzer lukasholzer added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Jan 17, 2022
@lukasholzer
Copy link
Collaborator

cc @KyleBlankRollins maybe you can outline the docs strategy on how we should document this. As flags are not documented on the file based configuration at all and I cannot find the functionsPort option either.

@erezrokah
Copy link
Contributor

Thanks @tinfoil-knight for the PR and @lukasholzer for the review πŸš€

We should also update https://github.com/netlify/cli/blob/41e6729c7413a170d96e6a6020b7200a478976bb/docs/netlify-dev.md#netlifytoml-dev-block, which is part of the CLI repo.

@lukasholzer for the docs site, we can open an issue on our private repo and link this PR and the relevant docs section (https://docs.netlify.com/configure-builds/file-based-configuration/#netlify-dev).

@lukasholzer
Copy link
Collaborator

lukasholzer commented Jan 18, 2022

@erezrokah I opened up a docs PR in our repository: https://github.com/netlify/docs/pull/1700 (private)

@lukasholzer lukasholzer added the automerge Add to Kodiak auto merge queue label Jan 19, 2022
@kodiakhq kodiakhq bot merged commit b58d689 into netlify:main Jan 19, 2022
@tinfoil-knight tinfoil-knight deleted the feat/dev-functions-port branch January 19, 2022 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Add to Kodiak auto merge queue type: feature code contributing to the implementation of a feature and/or user facing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow specifying functions server port for netlify dev via flag
3 participants