Skip to content

Conversation

Pallavi-Janardhan
Copy link

@Pallavi-Janardhan Pallavi-Janardhan commented Aug 7, 2025

This PR adds documentation about a new feature, OnDeploy, in the Eventing documentation.

Jira: DOC-12757
Preview: (https://preview.docs-test.couchbase.com/docs-devex-DOC-12757_Add_OnDeploy)
Preview credentials: Preview docs for internal review

Copy link
Contributor

@RayOffiah RayOffiah left a comment

Choose a reason for hiding this comment

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

Approved, but for things like this, you might want to think about using Asciidoc description lists instead.

https://docs.asciidoctor.org/asciidoc/latest/lists/description/

@simon-dew simon-dew changed the title Doc 12757 add on deploy DOC-12757 add on deploy Aug 7, 2025

The `OnDeploy` handler runs once when an Eventing function is deployed or resumed.

The entry point `OnUpdate(action)` receives an `action`, like `deploy` or `resume`, indicating the reason for invocation. It also includes a `delay` value (in milliseconds), representing the time elapsed since the function was paused. For deployment operations, this value is `0`

Choose a reason for hiding this comment

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

Suggesting following correction:

  1. The entry point OnUpdate(action) -> The entry point OnDeploy(action)
  2. receives an action -> receives an action parameter

Copy link
Author

Choose a reason for hiding this comment

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

Done and made the correction

Copy link

@Hirenb612 Hirenb612 left a comment

Choose a reason for hiding this comment

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

Looks good to me from the eventing side! 👍

@Pallavi-Janardhan Pallavi-Janardhan merged commit fb17cb8 into release/8.0 Aug 8, 2025
6 checks passed
@Pallavi-Janardhan Pallavi-Janardhan deleted the DOC-12757_Add_OnDeploy branch August 8, 2025 10:13
simon-dew added a commit that referenced this pull request Sep 9, 2025
---------

Co-authored-by: Pallavi-Janardhan <pallavi.janardhan@couchbase.com>
simon-dew added a commit that referenced this pull request Sep 11, 2025
---------

Co-authored-by: Pallavi-Janardhan <pallavi.janardhan@couchbase.com>
sarahlwelton pushed a commit that referenced this pull request Sep 24, 2025
---------

Co-authored-by: Pallavi-Janardhan <pallavi.janardhan@couchbase.com>
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.

3 participants