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

Added VersionDescription property on Serverless::Function #835

Merged
merged 3 commits into from
Mar 8, 2019
Merged

Added VersionDescription property on Serverless::Function #835

merged 3 commits into from
Mar 8, 2019

Conversation

Buffer0x7cd
Copy link
Contributor

@Buffer0x7cd Buffer0x7cd commented Mar 3, 2019

Issue #, if available:
#823
Description of changes:
This PR Add an Additional VersionDescription property on Serverless::Function.
Description of how you validated changes:
I validated the changes by creating an instance of SamFunction and then setting the VersionDescription property of the instance. after this i called the to_cloudformation method of SamFunction and validated that the string passed in VersionDescription is proprly set on the instance of LambdaVersion class under Description property.

Checklist:

  • [ x] Write/update tests
  • [ x] make pr passes
  • Update documentation: For the Documentation I was not sure which part to update. I though i need to add this inside the Version/2016-10-31 . but i thought asked this explicitly will be better.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov-io
Copy link

codecov-io commented Mar 3, 2019

Codecov Report

Merging #835 into develop will increase coverage by 0.33%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #835      +/-   ##
===========================================
+ Coverage    94.23%   94.56%   +0.33%     
===========================================
  Files           67       67              
  Lines         2688     2834     +146     
  Branches       478      508      +30     
===========================================
+ Hits          2533     2680     +147     
- Misses          80       82       +2     
+ Partials        75       72       -3
Impacted Files Coverage Δ
samtranslator/model/sam_resources.py 95.5% <100%> (-0.25%) ⬇️
samtranslator/plugins/api/implicit_api_plugin.py 96.35% <0%> (-3.65%) ⬇️
samtranslator/model/intrinsics.py 94.44% <0%> (-1.02%) ⬇️
samtranslator/sdk/resource.py 100% <0%> (ø) ⬆️
samtranslator/model/eventsources/cloudwatchlogs.py 100% <0%> (ø) ⬆️
samtranslator/model/api/api_generator.py 96.17% <0%> (+0.04%) ⬆️
samtranslator/model/eventsources/pull.py 92% <0%> (+0.33%) ⬆️
samtranslator/swagger/swagger.py 98.32% <0%> (+0.39%) ⬆️
samtranslator/model/__init__.py 98.11% <0%> (+1.25%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4bddf27...ef22c5c. Read the comment docs.

@keetonian
Copy link
Contributor

Hey! This looks great so far. Could you add this property into one of the E2E tests? The one at the path tests/translator/input/function_with_alias.yaml should be a good candidate. Once that one is updated, you'll have to add the field into the output files at tests/translator/output/function_with_alias.yaml, tests/translator/output/aws-us-gov/function_with_alias.yaml, and tests/translator/output/aws-cn/function_with_alias.yaml.

After that, this should be good to go! Thank you for contributing!

@Buffer0x7cd
Copy link
Contributor Author

Hey! @keetonian , Thanks for the response. I have updated the end to end tests as per your suggestion. please let me know if there are any other updates needed.

Copy link
Contributor

@keetonian keetonian left a comment

Choose a reason for hiding this comment

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

This looks good! Thank you for the contribution! Just add the new property to the documentation and we'll be able to merge it in.

@keetonian
Copy link
Contributor

@Buffer0x7cd Documentation- you have the file correct. You should add the property and a short description about it to https://github.com/awslabs/serverless-application-model/blob/develop/versions/2016-10-31.md#awsserverlessfunction

jlhood
jlhood previously requested changes Mar 7, 2019
Copy link
Contributor

@jlhood jlhood left a comment

Choose a reason for hiding this comment

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

Great work! Just make the documentation update @keetonian mentioned and this will be good to go!

@Buffer0x7cd
Copy link
Contributor Author

@jlhood I have added the VersionDescription Property in the documentation as requested. please feel free to review this PR.

@keetonian keetonian requested a review from jlhood March 8, 2019 18:09
@keetonian keetonian dismissed jlhood’s stale review March 8, 2019 18:10

Issue has been fixed.

@brettstack brettstack merged commit b4baac6 into aws:develop Mar 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants