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

remove invalid variable references from the documentation #11785

Merged
merged 2 commits into from Mar 10, 2023

Conversation

sleepwithcoffee
Copy link
Contributor

Closes: #8306

@sleepwithcoffee
Copy link
Contributor Author

  • Remove the mention about {self:} -> this was introduced at some point in the past but didn't work as expected and got removed by Variables: Fix support for "${self:}" #8343

  • Remove the mention about {env:} -> it was supposed to be a lazy way to import all environment variables into serverless according to the previous doc. Checked around but cannot seem to find any related implementation.
    Confirmed by ...\test\unit\lib\configuration\variables\sources\env.test.js that this syntax is not currently supported and should encounter error

Copy link
Contributor

@medikoo medikoo left a comment

Choose a reason for hiding this comment

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

Looks great 👍 Thank you @duytrandev

@codecov
Copy link

codecov bot commented Mar 9, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (ad8c24e) 86.56% compared to head (b449cb9) 86.56%.

❗ Current head b449cb9 differs from pull request most recent head efb8c3a. Consider uploading reports for the commit efb8c3a to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11785   +/-   ##
=======================================
  Coverage   86.56%   86.56%           
=======================================
  Files         314      314           
  Lines       13128    13128           
=======================================
  Hits        11364    11364           
  Misses       1764     1764           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@medikoo medikoo left a comment

Choose a reason for hiding this comment

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

@duytrandev can you ensure that changes follow Prettier formatting. CI failed due to that

@sleepwithcoffee
Copy link
Contributor Author

hi @medikoo I updated my code to resolve the prettier issue
maybe it's worth noting in the PR template to run npm run prettier-check:updated instead of npm run prettier?

@medikoo
Copy link
Contributor

medikoo commented Mar 9, 2023

hi @medikoo I updated my code to resolve the prettier issue
maybe it's worth noting in the PR template to run npm run prettier-check:updated instead of npm run prettier?

npm run prettier-check:updated depends on a state of main in your fork. Did you have problems with npm run prettier ?

@sleepwithcoffee
Copy link
Contributor Author

@medikoo I got a lot of warn notices to a point that I cannot tell any problem with my code even though I only updated 2 blocks of code

image

@medikoo
Copy link
Contributor

medikoo commented Mar 9, 2023

@medikoo I got a lot of warn notices to a point that I cannot tell any problem with my code even though I only updated 2 blocks of code

Maybe you have git configured on windows to change the end of line characters?

@sleepwithcoffee
Copy link
Contributor Author

hi @medikoo thanks for the pointer, I updated my workspace accordingly.
Updated and committed the code with proper formatting, please help to check and merge.

Copy link
Contributor

@medikoo medikoo left a comment

Choose a reason for hiding this comment

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

Thank you @duytrandev ! Great improvement.

Small hint: To mark PR as ready for re-review, best is to simply re-request review in reviewers box (we receive notification of such action)

@medikoo medikoo merged commit 974198a into serverless:main Mar 10, 2023
5 checks passed
@sleepwithcoffee sleepwithcoffee deleted the 8306_invalid_vars_in_doc branch March 13, 2023 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cleanup invalid variable examples from doc
2 participants