@@ -38,24 +38,24 @@ Before you begin, ensure you have the following:
3838
3939## ⚙️ Setup Instructions
4040
41- ### 1. Clone the Repository
41+ #### 1. Clone the Repository
4242``` bash
4343git clone https://github.com/ashikkumar23/jira-github-integration.git
4444cd jira-github-integration
4545```
4646
47- ### 2. Configure Secrets
47+ #### 2. Configure Secrets
4848Go to your repository's ** Settings** > ** Secrets and variables** > ** Actions** , and add the following secrets:
4949- ` JIRA_BASE_URL `
5050- ` JIRA_USER_EMAIL `
5151- ` JIRA_API_TOKEN `
5252
53- ### 3. Update the Workflow File
53+ #### 3. Update the Workflow File
5454The workflow file is located at ` .github/workflows/jira-integration.yml ` . Ensure the following is set:
5555- Replace ` JGI ` with your Jira project key.
5656- Adjust other parameters if needed.
5757
58- ### 4. Test the Workflow
58+ #### 4. Test the Workflow
5959- Create a new issue in the repository.
6060- Add the ` bug ` label to the issue.
6161- Check your Jira project for a new bug ticket.
@@ -70,46 +70,6 @@ The workflow file is located at `.github/workflows/jira-integration.yml`. Ensure
7070
7171---
7272
73- ## 📝 Example Workflow File
74-
75- The following is the GitHub Actions workflow file used in this project:
76-
77- ``` yaml name=.github/workflows/jira-integration.yml
78- name : Create Jira Issue on Label
79-
80- on :
81- issues :
82- types :
83- - labeled
84-
85- jobs :
86- create-jira-issue :
87- if : contains(github.event.label.name, 'bug') # Trigger only when the 'bug' label is added
88- runs-on : ubuntu-latest
89- steps :
90- - name : Login to Jira
91- uses : atlassian/gajira-login@v3
92- env :
93- JIRA_BASE_URL : ${{ secrets.JIRA_BASE_URL }} # The base URL of your Jira instance
94- JIRA_USER_EMAIL : ${{ secrets.JIRA_USER_EMAIL }} # The email associated with your Jira user
95- JIRA_API_TOKEN : ${{ secrets.JIRA_API_TOKEN }} # The API token for Jira
96-
97- - name : Create Jira Issue
98- uses : atlassian/gajira-create@v3
99- with :
100- project : JGI # The Jira project key where the issue should be created
101- issuetype : Bug # The type of issue to create
102- summary : ${{ github.event.issue.title }} # The title of the issue from GitHub
103- description : |
104- **Reporter:** ${{ github.actor }}
105-
106- **Issue URL:** ${{ github.event.issue.html_url }}
107-
108- **Description:** ${{ github.event.issue.body }}
109- ` ` `
110-
111- ---
112-
11373## 🌟 Limitations
11474- Currently supports only issues labeled as ` bug ` .
11575- Does not sync updates or status changes from Jira back to GitHub.
0 commit comments