Tired of manually managing autolinks for your project management tool issues in your GitHub repo? I have a solution for you!

This GitHub Action automatically synchronizes project management tool projects with GitHub repository autolinks. This ensures that issue references (e.g., PROJECT-123) in issues, pull requests, and commits automatically link to the corresponding tickets.

Currently supported tools:

• ✅ JIRA
• 🔄 Other tools (planned for future releases)

• Fetches all JIRA projects from your instance
• Creates autolinks for each project key (e.g., PROJECT- → https://your-jira.com/browse/PROJECT-123)
• Updates existing autolinks if JIRA URL changes
• Removes obsolete JIRA autolinks when projects are deleted
• Preserves non-JIRA autolinks
• Filter projects by category (supports GitHub's 500 autolinks limit)
• Discover available project categories

name: Sync JIRA Autolinks
on:
  schedule:
    - cron: '0 2 * * *'  # Run daily at 2 AM
  workflow_dispatch:  # Allow manual trigger

jobs:
  sync-autolinks:
    runs-on: ubuntu-latest
    steps:
      - uses: IlyaGulya/action-sync-autolinks@master
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          jira-url: ${{ vars.JIRA_URL }}
          jira-username: ${{ vars.JIRA_USERNAME }}
          jira-api-token: ${{ secrets.JIRA_API_TOKEN }}

- uses: IlyaGulya/action-sync-autolinks@master
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    jira-url: ${{ secrets.JIRA_URL }}
    jira-username: ${{ vars.JIRA_USERNAME }}
    jira-api-token: ${{ vars.JIRA_API_TOKEN }}
    repository: 'owner/repo'  # Optional: specify different repo
    dry-run: 'true'  # Optional: test changes without applying them

GitHub has a limit of 500 autolinks per repository. If your JIRA instance has more than 500 projects, you must use filters to reduce the number of synced projects.

Step 1: Discover Available Categories

- uses: IlyaGulya/action-sync-autolinks@master
  with:
    jira-url: ${{ secrets.JIRA_URL }}
    jira-username: ${{ vars.JIRA_USERNAME }}
    jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
    list-categories: 'true'  # Discovery mode - lists categories and exits

This will output available categories:

Found 3 project categories:

  ID: 10000, Name: ENGINEERING - Engineering Projects
  ID: 10001, Name: MARKETING - Marketing Campaigns
  ID: 10002, Name: SUPPORT - Customer Support

To filter projects by category, use the filter-project-category-ids input:
  filter-project-category-ids: '10000,10001'

Step 2: Filter Projects by Category

- uses: IlyaGulya/action-sync-autolinks@master
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    jira-url: ${{ secrets.JIRA_URL }}
    jira-username: ${{ vars.JIRA_USERNAME }}
    jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
    filter-project-category-ids: '10000,10001'  # Only sync Engineering and Marketing projects

- uses: IlyaGulya/action-sync-autolinks@master
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    jira-url: ${{ secrets.JIRA_URL }}
    jira-username: ${{ vars.JIRA_USERNAME }}
    jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
    filter-project-type: 'software,business'  # Only sync software and business projects

Valid types: business, service_desk, software

- uses: IlyaGulya/action-sync-autolinks@master
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    jira-url: ${{ secrets.JIRA_URL }}
    jira-username: ${{ vars.JIRA_USERNAME }}
    jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
    filter-project-query: 'platform'  # Only sync projects with 'platform' in key or name (case insensitive)

- uses: IlyaGulya/action-sync-autolinks@master
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    jira-url: ${{ secrets.JIRA_URL }}
    jira-username: ${{ vars.JIRA_USERNAME }}
    jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
    filter-project-category-ids: '10000'  # Engineering category
    filter-project-type: 'software'        # Software projects only
    filter-project-query: 'api'            # With 'api' in name or key

1. Go to your JIRA instance
2. Navigate to Account Settings → Security → API tokens
3. Create a new API token
4. Save the token securely

Add these secrets to your repository:

• JIRA_URL: Your JIRA instance URL (e.g., https://company.atlassian.net)
• JIRA_USERNAME: Your JIRA username or email
• JIRA_API_TOKEN: The API token created above

The action requires:

• Repository administration permissions (to manage autolinks)
• JIRA project browse permissions (to list projects)

1. Fetch JIRA Projects: Uses JIRA REST API to get all accessible projects
2. Get Existing Autolinks: Retrieves current repository autolinks via GitHub API
3. Sync Process:
   • Creates new autolinks for JIRA projects that don't have them
   • Updates existing autolinks if the JIRA URL changed
   • Removes obsolete JIRA autolinks (preserves non-JIRA ones)
4. Result: JIRA references like PROJ-123 automatically link to https://your-jira.com/browse/PROJ-123

After running, references in issues and PRs will automatically link:

• MYPROJ-123 → Links to https://company.atlassian.net/browse/MYPROJ-123
• TASK-456 → Links to https://company.atlassian.net/browse/TASK-456

• Ensure the GitHub token has repository admin permissions
• Verify JIRA credentials have project browse access

• Check JIRA URL format (should include protocol: https://)
• Verify API token and username are correct
• Ensure user has access to JIRA projects

• Error: "Found XXX JIRA projects, but GitHub only supports up to 500 autolinks per repository"
• Solution: Use filtering inputs to reduce the number of projects
• Available Filters:
  • filter-project-category-ids: Filter by category (run with list-categories: true to see available categories)
  • filter-project-type: Filter by type (business, service_desk, software)
  • filter-project-query: Filter by project key or name (case insensitive)
• Tip: Combine multiple filters for more precise results

• Repository admin permissions required for autolink management
• Check if autolink limits are reached (GitHub has a 500 autolinks limit per repository)

MIT