README.md

issue-sync-action

Used to sync issues and comments from one repository to another, for example, for use in internal roadmap publication.

You need to set a GITHUB_TOKEN environment variable that is authorized to read from the source repository as well as write new issues to the target repository.

Alternatively, you can set two separate environment variables GITHUB_TOKEN_SOURCE and GITHUB_TOKEN_TARGET

Usage

See the list of supported options in action.yml

Example

---
name: issue-sync

on:
  issues:
    types: [closed, deleted, edited, labeled, opened, reopened, unlabeled]
  issue_comment:
    types: [created, edited, deleted]  # if only_sync_main_issue: false

jobs:
  issue-sync:
    runs-on: ubuntu-latest
    if: contains( github.event.issue.labels.*.name, 'public')  # limits this workflow to only run on issues and comments with the label, cost saving measure
    steps:
    - name: Run the typescript action
      uses: camunda/issue-sync-action
      id: issue_sync
      with:
        repo_target: "MyOrg/public-roadmap"  # The target repository
        only_sync_on_label: "publicise"  # Only syncs issues with this label set
        only_sync_main_issue: false  # Sync comments in addition to the issue
        additional_issue_labels: "label1,label2"
        target_issue_footer_template: '<sup>:robot: This issue is automatically synced from: [source]({{<link>}})</sup>'
        target_comment_footer_template: '<sup>:robot: This comment from {{<author>}} is automatically synced from: [source]({{<link>}})</sup>'
        skip_comment_sync_keywords: '[skip-sync],[private]'
        issue_created_comment_template: |
          A public reference has been created: {{<link>}}
          **Notice**: comments after this one **are** synchronized with the public copy of the issue.
        use_comment_for_issue_matching: true
        target_issue_assignees_behavior: "add_source_author"
      env:
        GITHUB_TOKEN_SOURCE: ${{ secrets.GH_TOKEN_FOR_SOURCE }}
        GITHUB_TOKEN_TARGET: ${{ secrets.GH_TOKEN_FOR_TARGET }}
        # alternatively, you can pass only GITHUB_TOKEN if it works for both source and target 
    - run: |
      echo "issue_id_target: ${{ steps.issue_sync.outputs.issue_id_target }}"
      echo "comment_id_target: ${{ steps.issue_sync.outputs.comment_id_target }}"