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

GitAuto: Listen jira issue webhook event on this Jira Forge App #19

Closed

Conversation

gitauto-ai[bot]
Copy link
Contributor

@gitauto-ai gitauto-ai bot commented Dec 7, 2024

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

  1. 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.

  2. 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.

  3. 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.

  4. 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.

  5. 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

git checkout -b gitauto/issue-17-c2a81c26-40fd-4055-b987-bab4735ed2a8
git pull origin gitauto/issue-17-c2a81c26-40fd-4055-b987-bab4735ed2a8

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.

Listen jira issue webhook event on this Jira Forge App
1 participant