GitAuto: Listen jira issue webhook event on this Jira Forge App #19
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #17
What is the feature
Add the capability to listen to Jira issue webhook events within the Jira Forge App.
Why we need the feature
Integrating webhook event listening will allow the app to respond in real-time to changes in Jira issues, enabling automated workflows, notifications, and enhanced interactivity for users. This functionality is essential for creating a dynamic and responsive application that can handle issue updates, creations, and deletions promptly.
How to implement and why
Setup Webhook Subscription:
Configure the
manifest.yml
to subscribe to relevant Jira webhook events such as issue creation, updates, and deletions. This ensures that the app receives notifications whenever these events occur.Implement Event Handlers:
Within the
src
directory, create modules responsible for handling incoming webhook events. These handlers will parse the event payloads and execute corresponding actions, such as updating the UI or triggering other processes within the app.Update Permissions:
Modify the
manifest.yml
to request the necessary permissions for accessing webhook events and Jira issues. Ensuring the correct permissions are set is crucial for the app to function properly and securely.Testing:
Develop unit and integration tests to verify that webhook events are correctly received and handled. Testing ensures the reliability of the feature and helps identify any potential issues before deployment.
Documentation:
Update the
README.md
to include information about the new webhook feature, how to configure it, and any prerequisites. Clear documentation facilitates ease of use and maintenance.Implementing the feature step-by-step ensures a structured approach, adherence to Jira Forge guidelines, and maintains the application's stability and scalability.
About backward compatibility
Adding webhook event listeners should not interfere with existing functionalities of the app. However, it's essential to ensure that the integration does not introduce any conflicts or unintended side effects. Proper testing and validation will help maintain backward compatibility. Additionally, documenting any changes in permissions or configurations will inform users of new requirements without disrupting their current setup.
Test these changes locally