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

Add support for Description property to EventBridge rules #11821

Merged

Conversation

anthonyroussel
Copy link
Contributor

@anthonyroussel anthonyroussel commented Mar 16, 2023

Add support for Description property to EventBridge rules

functions:
  hello:
    handler: handlers.fn
    events:
      - eventBridge:
          name: 'eventBridgeRule'
          description: 'My EventBridge rule description'
          inputTransformer: 
            inputPathsMap:
              time: '$.time'
            inputTemplate: '{"time": <time>}'
          enabled: true
          schedule: 'cron(0 5 * * ? *)'

@anthonyroussel anthonyroussel changed the title Add Description to EventBridge rules Add support for Description property to EventBridge rules Mar 16, 2023
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 @anthonyroussel, that looks very good!

The only thing we're missing here, is documentation, which best if added at:
https://github.com/serverless/serverless/blob/f606014e033330ea746cec0141cbaf1d5f556e60/docs/providers/aws/guide/serverless.yml.md

@anthonyroussel
Copy link
Contributor Author

Hello @medikoo.

Thanks for the review.

I have added some documentation about the Description field in docs/providers/aws/guide/serverless.yml.md.

What do you think?

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 👍

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.

@anthonyroussel unfortunately CI is failing with lint error, can you check that?

@anthonyroussel anthonyroussel force-pushed the add-description-on-eventbridge-rule branch from 36b38e1 to 9781225 Compare March 16, 2023 10:58
@anthonyroussel
Copy link
Contributor Author

Ooops sorry! I fixed the test.

@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (a8f118b) 85.67% compared to head (cd5378a) 85.67%.

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11821   +/-   ##
=======================================
  Coverage   85.67%   85.67%           
=======================================
  Files         316      316           
  Lines       13342    13343    +1     
=======================================
+ Hits        11431    11432    +1     
  Misses       1911     1911           
Impacted Files Coverage Δ
...s/aws/package/compile/events/event-bridge/index.js 97.70% <100.00%> (+0.01%) ⬆️

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 in Codecov by Sentry.
📢 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.

Thank you 👍

@medikoo medikoo merged commit 2efe816 into serverless:main Mar 16, 2023
5 checks passed
@anthonyroussel anthonyroussel deleted the add-description-on-eventbridge-rule branch March 16, 2023 12:24
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.

None yet

2 participants