feat(action): updated this action from Docker to Composite type

Author: tomassebestik

CHANGELOG.md

@@ -1,3 +1,29 @@
+# CHANGELOG
+
+> All notable changes to this project are documented in this file.
+> This list is not exhaustive - only important changes, fixes, and new features in the code are reflected here.
+
+<sub>The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),     [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and     [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+</sub>
+
+---
+
+## Unreleased
+
+### ✨ New features
+
+- **action**: updated this action from Docker to Composite type *(Tomas Sebestik - d926676)*
+
+### 🐛 Bug fixes
+
+- add dynamic ref to action.yml file for development testing *(Tomas Sebestik - 39cd704)*
+
+### 📖 Documentation
+
+- **caller-workflow**: add caller workflow for easy copy to target repo *(Tomas Sebestik - d651127)*
+
+---
+
 ## v0.1.1 (2024-02-14)
 
 

Dockerfile

@@ -1,14 +1,74 @@
-name: "GitHub to JIRA Issue Sync"
-description: "Performs simple one way syncing of GitHub issues into JIRA."
-branding:
-  icon: "fast-forward"
-  color: "green"
+---
+name: Sync GitHub Pull requests and Issues to JIRA
+description: >
+  Synchronizes Issues, Issue comments and Pull Requests from Espressif GitHub to Espressif JIRA.
+
 inputs:
   cron_job:
     description: >
-      Whether the action is run as a cron job.
-      Set true to trigger syncing of new PRs.
-    required: false
+      THIS INPUT IS INCLUDED ONLY FOR COMPATIBILITY WITH LEGACY CALLER WORKFLOWS.
+      ALL LOGIC IS DETERMINED BASED ON THE ACTION TRIGGER; THIS INPUT DOES EFFECTIVELY NOTHING
+      Indicates whether the action is being run as a scheduled cron job
+      If so, the it syncs new pull requests during the cron job execution.
+
+  jira-project:
+    description: >
+      The key of the JIRA project where issues will be created or updated.
+      It can be passed either as an input `with: jira-project: <jira_key>`
+      or as an environment variable `ENV: JIRA_PROJECT: <jira_key>` (legacy).
+      If this is not passed one way or another, a check in the sync script will cause the action to fail.
+
+  jira-component:
+    description: 'The JIRA component to which the issues will be assigned. Default = "GitHub"'
+    default: 'GitHub'
+
+  jira-issue-type:
+    description: 'The type of JIRA issue to be created if no labels to the issue are set. Default = "Task"'
+    default: 'Task'
+
 runs:
-  using: "docker"
-  image: "Dockerfile"
+  using: composite
+  steps:
+    - name: Checkout action repository (espressif/sync-jira-actions)
+      uses: actions/checkout@v4
+      with:
+        repository: espressif/sync-jira-actions
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+        cache: pip
+
+    - name: Install Python dependencies
+      shell: bash
+      run: |
+        python -m venv venv
+        source venv/bin/activate
+        pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: npm
+
+    - name: Install npm dependencies (markdown2confluence)
+      shell: bash
+      run: npm ci
+
+    - name: Run sync_to_jira.py
+      shell: bash
+      run: |
+        source venv/bin/activate
+        python sync_jira_actions/sync_to_jira.py
+      env:
+        GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }} # Needs to be passed from caller workflow; by ENV (secure), not by input
+        JIRA_PASS: ${{ env.JIRA_PASS }} # Needs to be passed from caller workflow; by ENV (secure), not by input
+        JIRA_URL: ${{ env.JIRA_URL }} # Needs to be passed from caller workflow; by ENV (secure), not by input
+        JIRA_USER: ${{ env.JIRA_USER }} # Needs to be passed from caller workflow; by ENV (secure), not by input
+        INPUT_CRON_JOB: ${{ github.event_name == 'schedule' && 'true' || '' }}
+        JIRA_PROJECT: ${{ inputs.jira-project }}
+        JIRA_COMPONENT: ${{ inputs.jira-component }}
+        JIRA_ISSUE_TYPE: ${{ inputs.jira-issue-type }}

action.yml

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@shogobg/markdown2confluence": "^0.1.6"
+  }
+}

package-lock.json

@@ -44,7 +44,8 @@ def handle_issue_opened(jira, event):
         return
 
     print('Creating new JIRA issue for new GitHub issue')
-    _create_jira_issue(jira, event['issue'])
+    issue = _create_jira_issue(jira, event['issue'])
+    print(f'✔️ Successfully synchronized new GitHub issue #{gh_issue["number"]} to JIRA issue {issue.key}')
 
 
 def handle_issue_edited(jira, event):
@@ -133,7 +134,8 @@ def handle_comment_created(jira, event):
     gh_comment = event['comment']
 
     jira_issue = _find_jira_issue(jira, event['issue'], True)
-    jira.add_comment(jira_issue.id, _get_jira_comment_body(gh_comment))
+    jira_comment = jira.add_comment(jira_issue.id, _get_jira_comment_body(gh_comment))
+    print(f'✔️ Successfully synchronized comment (ID: {jira_comment.id}) for JIRA issue {jira_issue.key}')
 
 
 def handle_comment_edited(jira, event):
@@ -152,15 +154,17 @@ def handle_comment_edited(jira, event):
             break
 
     if not found:  # if we didn't find the old comment, make a new comment about the edit
-        jira.add_comment(jira_issue.id, _get_jira_comment_body(gh_comment))
+        jira_comment = jira.add_comment(jira_issue.id, _get_jira_comment_body(gh_comment))
+        print(f'✔️ Successfully synchronized comment (ID: {jira_comment.id}) for JIRA issue {jira_issue.key}')
 
 
 def handle_comment_deleted(jira, event):
     gh_comment = event['comment']
     jira_issue = _find_jira_issue(jira, event['issue'], True)
-    jira.add_comment(
+    jira_comment = jira.add_comment(
         jira_issue.id, f"@{gh_comment['user']['login']} deleted [GitHub issue comment|{gh_comment['html_url']}]"
     )
+    print(f'✔️ Successfully synchronized deleted comment (ID: {jira_comment.id}) for JIRA issue {jira_issue.key}')
 
 
 # Works both for issues and pull requests
@@ -224,7 +228,7 @@ def _markdown2wiki(markdown):
                 mdf.write('\n')
 
         try:
-            subprocess.check_call(['markdown2confluence', md_path, conf_path])
+            subprocess.check_call(['npx', 'markdown2confluence', md_path, conf_path])  # noqa: S603, S607
             with open(conf_path, 'r', encoding='utf-8') as file:
                 result = file.read()
             if len(result) > 16384:  # limit any single body of text to 16KB (JIRA API limits total text to 32KB)
@@ -445,7 +449,8 @@ def _find_jira_issue(jira, gh_issue, make_new=False, retries=5):
     """
     url = gh_issue['html_url']
     jql_query = f'issue in issuesWithRemoteLinksByGlobalId("{url}") order by updated desc'
-    print(f'JQL query: {jql_query}')
+    if os.environ.get('ACTIONS_RUNNER_DEBUG') == 'true':
+        print(f'JQL query: {jql_query}')  # Print the JQL query only in debug mode
     res = jira.search_issues(jql_query)
     if not res:
         print(f"WARNING: No JIRA issues have a remote link with globalID '{url}'")

package.json

@@ -44,3 +44,4 @@ def sync_remain_prs(jira):
             issue = _find_jira_issue(jira, gh_issue)
             if issue is None:
                 _create_jira_issue(jira, gh_issue)
+                print(f'✔️ Successfully synchronized PR #{pr.number}')

sync_jira_actions/sync_issue.py

@@ -40,36 +40,44 @@ def applicationlinks(self):
 
 def main():
     if 'GITHUB_REPOSITORY' not in os.environ:
-        print('Not running in GitHub action context, nothing to do')
+        print('❌ Not running in GitHub action context, nothing to do')
         return
 
     if not os.environ['GITHUB_REPOSITORY'].startswith('espressif/'):
-        print('Not an Espressif repo, nothing to sync to JIRA')
+        print('❌ Not an Espressif repo, nothing to sync to JIRA')
         return
 
+    # For backward compatibility; handles situation if JIRA_PROJECT is not set in caller workflow either as input or ENV
+    if 'JIRA_PROJECT' not in os.environ:
+        print('❌ JIRA_PROJECT not set, fail!')
+        raise SystemExit(1)
+
     # Connect to Jira server
     print('Connecting to Jira Server...')
 
     # Check if the JIRA_PASS is token or password
     token_or_pass = os.environ['JIRA_PASS']
     if token_or_pass.startswith('token:'):
-        print('Authenticating with JIRA_TOKEN ...')
+        if os.environ.get('ACTIONS_RUNNER_DEBUG') == 'true':
+            print('Authenticating with JIRA_TOKEN ...')
         token = token_or_pass[6:]  # Strip the 'token:' prefix
         jira = _JIRA(os.environ['JIRA_URL'], token_auth=token)
     else:
-        print('Authenticating with JIRA_USER and JIRA_PASS ...')
+        if os.environ.get('ACTIONS_RUNNER_DEBUG') == 'true':
+            print('Authenticating with JIRA_USER and JIRA_PASS ...')
         jira = _JIRA(os.environ['JIRA_URL'], basic_auth=(os.environ['JIRA_USER'], token_or_pass))
 
     # Check if it's a cron job
-    if os.environ.get('INPUT_CRON_JOB'):
+    if os.environ.get('INPUT_CRON_JOB') == 'true':
         print('Running as a cron job. Syncing remaining PRs...')
         sync_remain_prs(jira)
         return
 
     # The path of the file with the complete webhook event payload. For example, /github/workflow/event.json.
     with open(os.environ['GITHUB_EVENT_PATH'], 'r', encoding='utf-8') as file:
         event = json.load(file)
-        print(json.dumps(event, indent=4))
+        if os.environ.get('ACTIONS_RUNNER_DEBUG') == 'true':
+            print(json.dumps(event, indent=4))
 
     event_name = os.environ['GITHUB_EVENT_NAME']
 
@@ -79,16 +87,16 @@ def main():
         inputs = event.get('inputs')
 
         if not inputs:
-            print('Triggered workflow_dispatch event without correct inputs. Exiting...')
+            print('❌ Triggered workflow_dispatch event without correct inputs. Exiting...')
             return
 
         input_action = inputs.get('action')
         issue_numbers = inputs.get('issue-numbers')
         if input_action != 'mirror-issues':
-            print('This action needs input "mirror-issues". Exiting...')
+            print('❌ This action needs input "mirror-issues". Exiting...')
             return
         if not issue_numbers:
-            print('This action needs inputs "issue-numbers". Exiting...')
+            print('❌ This action needs inputs "issue-numbers". Exiting...')
             return
 
         print(f'Starting manual sync of issues: {issue_numbers}')

sync_jira_actions/sync_pr.py

@@ -55,6 +55,7 @@ def test_handle_issue_opened_event(mock_environment, sync_to_jira_main, monkeypa
     }
     mock_environment.write_text(json.dumps(event_data))
     monkeypatch.setenv('GITHUB_EVENT_NAME', 'issues')
+    monkeypatch.setenv('JIRA_PROJECT', 'TEST_PROJECT')
 
     with patch('sync_jira_actions.sync_to_jira.handle_issue_opened') as mock_handle_issue_opened:
         sync_to_jira_main()