Skip to content

Conversation

@kumekay
Copy link
Collaborator

@kumekay kumekay commented Aug 18, 2025

Description

Add WEBHOOK_URL (optional) for an URL which will be called after every successful JIRA ticket update

Related

Testing

Successful test pipeline:
https://github.com/espressif/test-project-bot/actions/runs/17070187014/job/48396799666#step:3:303

Receieved Webhook can be found in windmill


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@kumekay kumekay requested a review from a team as a code owner August 18, 2025 11:05
@kumekay kumekay requested review from tomassebestik and removed request for a team August 18, 2025 11:05
@kumekay kumekay marked this pull request as draft August 18, 2025 11:06
@github-actions
Copy link

github-actions bot commented Aug 18, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello kumekay, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against c67cf8e

@kumekay
Copy link
Collaborator Author

kumekay commented Aug 18, 2025

@tomassebestik Don't you mind this approach?

@tomassebestik
Copy link
Member

@tomassebestik Don't you mind this approach?

@kumekay Added functionality and the way it’s implemented look good to me (the long-term plan is to rewrite this action from scratch, and this looks clear and easily portable to the future code version).

It would be helpful tho, to describe this new webhook feature a bit in the project docs (README). What that is, why repo admins should set that and maybe with an example. WDYT?

@kumekay kumekay force-pushed the feat/add-webhook branch 3 times, most recently from 91e444a to 7601b87 Compare August 18, 2025 16:56
@kumekay kumekay force-pushed the feat/add-webhook branch 2 times, most recently from a386735 to 7cf3d3f Compare August 19, 2025 11:33
@kumekay kumekay marked this pull request as ready for review August 19, 2025 11:36
@kumekay kumekay marked this pull request as draft August 19, 2025 12:52
@kumekay kumekay requested a review from Copilot August 19, 2025 12:56
@kumekay kumekay marked this pull request as ready for review August 19, 2025 12:57
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds webhook functionality to send notifications after successful JIRA ticket synchronization operations. The implementation allows for optional webhook notifications by setting the WEBHOOK_URL environment variable.

Key changes:

  • Creates a new webhook module with comprehensive payload structure
  • Integrates webhook calls into all sync operations (manual, cron, and event-driven)
  • Adds comprehensive test coverage for webhook functionality

Reviewed Changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
sync_jira_actions/webhook.py New webhook module implementing notification sending with proper error handling
tests/test_webhook.py Complete test suite covering success, failure, and edge cases for webhook functionality
sync_jira_actions/sync_to_jira.py Main integration point adding webhook calls after successful actions
sync_jira_actions/sync_issue.py Modified issue handlers to return JIRA issue objects for webhook payload
sync_jira_actions/sync_pr.py Added callback support for PR synchronization operations
action.yml Added WEBHOOK_URL environment variable configuration
README.md Documentation for webhook configuration and payload structure
Other files Version bump, dependency updates, and configuration changes

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@kumekay kumekay merged commit c71b222 into v1 Aug 19, 2025
4 checks passed
@kumekay kumekay deleted the feat/add-webhook branch August 19, 2025 13:07
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