AI agent to automate Jira to GitHub workflow #2601
Conversation
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
…RT-15733-jira-issue-to-git-hub-ai-agent
…ithub.com/port-labs/port-docs into PORT-15733-jira-issue-to-git-hub-ai-agent
| description: "Learn how to create an AI agent that automatically generates GitHub issues from Jira tickets and assigns them to Copilot", | ||
| tags: ["SDLC", "Jira", "GitHub", "AI"], | ||
| logos: ["Jira", "GitHub", "AI"], | ||
| link: "/guides/all/create-ai-agent-to-automate-jira-to-github-workflow", |
There was a problem hiding this comment.
let's update the file name to somethign simpler like automate-jira-to-github-copilot
docs/guides/all/create-ai-agent-to-automate-jira-to-github-workflow.md
Outdated
Show resolved
Hide resolved
|
|
||
| # Create AI agent to automate Jira to GitHub workflow | ||
|
|
||
| This guide demonstrates how to create an AI agent that streamlines your development workflow by automatically generating GitHub issues from Jira tickets, assigning them to GitHub Copilot and linking pull requests back to Jira. You will learn how to set up a complete automation that bridges Jira and GitHub, enabling seamless ticket-to-deployment workflow. |
There was a problem hiding this comment.
Let's try to phrase it for the first part on pain points, e.g., "coding agents are fast, but important engineering context get lost in the process. In this guide..
| 3. Add labels to GitHub issues after creation | ||
| 4. Update Jira tickets with pull request links | ||
|
|
||
| ### Automation to trigger AI agent |
There was a problem hiding this comment.
here we should share in a top that this automation can hev multiple approches to select which issues to trigger
- Based on a label (current)
- #of users Based on a different proprty and ownership
From Yonatan:
an explanation that in Port, you can configure exactly when you want to trigger an agent to perform a task. For example, you might want the agent to run only when a Jira issue has specific labels.
| <img src="/img/guides/jira-to-github-pr-workflow.jpg" border="1px" width="100%" /> | ||
|
|
||
|
|
||
| ## Common use cases |
There was a problem hiding this comment.
@PeyGis this is describing what the workflow does, not what the common use cases are
Common use cases might be "Automate PR creation for small bugs", or "Provide easy access to Copilot when not using Github Issues broadly"
Can you come up with the 3-4 use cases?
docs/guides/all/create-ai-agent-to-automate-jira-to-github-workflow.md
Outdated
Show resolved
Hide resolved
|
|
||
| When installing the Port's GitHub app, the pull request and repository blueprints are created by default. However, the GitHub issue blueprint needs to be created manually. | ||
|
|
||
| 1. Go to the [builder](https://app.getport.io/settings/data-model) page of your portal. |
There was a problem hiding this comment.
A general suggestion, would it make sense to have a shared component on "how to add a blueprint"? I see we keep having these same 4 lines
| 4. Copy and paste the following JSON configuration: | ||
|
|
||
| <details> | ||
| <summary><b>GitHub issue blueprint (Click to expand)</b></summary> |
There was a problem hiding this comment.
If I already installed the Github integration, won't I get it out of the box?
If the answer is that I will, worth saying "optional - if you already have the Github Issue blueprint, skip this step"
There was a problem hiding this comment.
The GitHub integration only creates the repo and pull request OOTB. You will have to manually create the issue bp
| operator: '"="' | ||
| value: .fields.customfield_10039.value | ||
| // highlight-start | ||
| pull_request: |
There was a problem hiding this comment.
What is the workflow make sure that the Jira key is always appearing in the PR title?
| "properties": { | ||
| "description": "Creates Github issues from Jira tickets", | ||
| "status": "active", | ||
| "allowed_blueprints": [ |
There was a problem hiding this comment.
Are there more blueprints/integrations that make sense to put here, given the demo we show?
Also, let's add a note before/after that the more integrations/data you add to the agent, the more context it will give to Copilot agent
Add examples like deployment history, related incidents, etc
|
|
||
| 4. Click `Create` to save the automation. | ||
|
|
||
| ### Automation to add labels to GitHub issues |
There was a problem hiding this comment.
let's add under each automation a very short explanation on WHY we need it
Here, for example, "When creating a Github issue via the API, you can't set its labels. This automation does it right after creating the Github issue"
| }, | ||
| "invocationMethod": { | ||
| "type": "WEBHOOK", | ||
| "url": "https://your-domain.atlassian.net/rest/api/3/issue/{{ .event.diff.before.identifier }}/comment", |
There was a problem hiding this comment.
Add a note to replace it with your atlassian domain
| "content": [ | ||
| { | ||
| "type": "text", | ||
| "text": "We've discovered a PR for this issue. Find the link below:" |
There was a problem hiding this comment.
Maybe "Port opened a PR for this issue"
| <img src="/img/guides/jira-to-github-ai-test.png" border="1px" width="100%" /> | ||
|
|
||
|
|
||
| ## Best practices |
There was a problem hiding this comment.
I think we can remove this section, it's pretty generic, and we can add the important stuff througout the guide
Co-authored-by: Matanga1-2 <matangrady@gmail.com>
…kflow.md Co-authored-by: Matanga1-2 <matangrady@gmail.com>
…kflow.md Co-authored-by: Matanga1-2 <matangrady@gmail.com>
…kflow.md Co-authored-by: Matanga1-2 <matangrady@gmail.com>
…kflow.md Co-authored-by: Matanga1-2 <matangrady@gmail.com>
…kflow.md Co-authored-by: Matanga1-2 <matangrady@gmail.com>
…ithub.com/port-labs/port-docs into PORT-15733-jira-issue-to-git-hub-ai-agent
|
Claude finished @PeyGis's task —— View job PR Review: AI agent to automate Jira to GitHub workflowReviewing this PR according to CONTRIBUTING.md guidelines... Todo List:
SummaryThis PR adds a comprehensive guide for automating Jira-to-GitHub workflows using AI agents and GitHub Copilot. The implementation includes new documentation, component configuration updates, and supporting images. Review Findings✅ Strengths
|
|
@PeyGis we discussed let's include in this PR two guides:
|
…ithub.com/port-labs/port-docs into PORT-15733-jira-issue-to-git-hub-ai-agent
|
Claude finished @PeyGis's task —— View job PR Review: AI agent to automate Jira to GitHub workflowReviewing this PR according to CONTRIBUTING.md guidelines... Todo List:
SummaryThis PR adds a comprehensive guide for automating Jira-to-GitHub workflows using AI agents and GitHub Copilot. The implementation includes new documentation, component configuration updates, and supporting images. Review Findings✅ Strengths
|
| - You have access to [create and configure AI agents](https://docs.port.io/ai-agents/overview#getting-started-with-ai-agents) in Port. | ||
| - You have completed the setup in the [Trigger GitHub Copilot from Port guide](https://docs.port.io/guides/all/trigger-github-copilot-from-port), ensuring that Copilot will be automatically assigned to any GitHub issues created through this guide. | ||
|
|
||
| :::tip Alternative integrations |
There was a problem hiding this comment.
Add another note that this shows Githbu Copiot but you could similarly use any other coding agent like Claude code Devin etc
| 5. Click `Save` to update the integration configuration. | ||
|
|
||
|
|
||
| ## Set up self-service actions |
There was a problem hiding this comment.
redundant? no need for this title anymore
|
Claude finished @PeyGis's task —— View job PR Review: AI agent to automate Jira to GitHub workflowReviewing this PR according to CONTRIBUTING.md guidelines... Todo List:
SummaryThis PR adds a comprehensive guide for automating Jira-to-GitHub workflows using AI agents and GitHub Copilot. The implementation includes new documentation, component configuration updates, and supporting images. Review Findings✅ Strengths
|
…ithub.com/port-labs/port-docs into PORT-15733-jira-issue-to-git-hub-ai-agent
|
Claude finished @PeyGis's task —— View job PR Review: AI agent to automate Jira to GitHub workflowReviewing this PR according to CONTRIBUTING.md guidelines... Todo List:
SummaryThis PR adds a comprehensive guide for automating Jira-to-GitHub workflows using AI agents and GitHub Copilot. The implementation includes new documentation, component configuration updates, and supporting images. Review Findings✅ Strengths
|
|
Claude finished @PeyGis's task —— View job PR Review: AI agent to automate Jira to GitHub workflowReviewing this PR according to CONTRIBUTING.md guidelines... Todo List:
SummaryThis PR adds a comprehensive guide for automating Jira-to-GitHub workflows using AI agents and GitHub Copilot. The implementation includes new documentation, component configuration updates, and supporting images. Review Findings✅ Strengths
|
|
Claude finished @PeyGis's task —— View job PR Review: AI agent to automate Jira to GitHub workflowReviewing this PR according to CONTRIBUTING.md guidelines... Todo List:
SummaryThis PR adds a comprehensive guide for automating Jira-to-GitHub workflows using AI agents and GitHub Copilot. The implementation includes new documentation, component configuration updates, and supporting images. Review Findings✅ Strengths
|
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
Added docs pages
Please also include the path for the added docs
/)/platform-overview/port-components/blueprint)Updated docs pages
Please also include the path for the updated docs
/)/platform-overview/port-components/blueprint)