-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
2.17 Add a New Issue Integration
github-actions[bot] edited this page Feb 20, 2026
·
1 revision
How to add a new issue tracker (e.g. Jira, GitHub, GitLab-style) to Super Productivity.
New integrations implement the shared IssueProvider pattern: models, API service, and a common-interfaces service that implements IssueServiceInterface. The integration is then registered in core issue model and config.
- Create a directory under
src/app/features/issue/providers/(e.g.my-provider/). - Add model files (config and issue types), API service, and a common-interfaces service implementing
IssueServiceInterface. - Add constants and config form section; implement required interface methods (e.g.
isEnabled,testConnection$,getById$,searchIssues$,getFreshDataForIssueTask). - Register the provider in
issue.model.ts(IssueProviderKey, IssueIntegrationCfg, IssueIntegrationCfgs, IssueProvider),issue.const.ts(type constant, ISSUE_PROVIDER_TYPES, DEFAULT_ISSUE_PROVIDER_CFGS, ISSUE_PROVIDER_FORM_CFGS_MAP), and ensure the issue service injects and uses it. - Optionally add UI (issue content, header, config) in provider-specific subfolders.
- Run the app, add the integration in settings, and test connection and issue flow.
Step-by-step instructions, file templates, and the exact interface methods to implement are in the repository:
Use an existing provider (e.g. GitHub or GitLab under src/app/features/issue/providers/) as a reference.
If you have further questions, please refer to the discussions page.
- 2.01-Downloads and Install
- 2.02-Restore-Data-From-Backup
- 2.03-Add-Tasks
- 2.04-Manage-Subtasks
- 2.05-Manage-Scheduled-Tasks
- 2.06-Manage-Repeating-Tasks
- 2.07-Manage-Task-Integrations
- 2.08-Choose-Sync-Backend
- 2.09-Configure-Sync-Backend
- 2.13-Run-with-Docker
- 2.18-Contribute-Translations
- 2.11-Run-the-Development-Server
- 2.16-Set-Up-Development-Environment
- 2.12-Package-the-App
- 2.14-Build-for-Android
- 2.15-Develop-a-Plugin
- 2.17-Add-a-New-Issue-Integration
- 3.01-API
- 3.02-Settings-and-Preferences
- 3.03-Keyboard-Shortcuts
- 3.04-Short-Syntax
- 3.05-Web-App-vs-Desktop
- 3.06-User-Data
- 3.07-Issue-Integration-Comparison
- 3.08-Sync-Integration-Comparison
- 3.09-Theming
- 4.06-Project-View
- 4.07-Tag-View
- 4.08-Time-Estimates
- 4.09-Task-Attributes
- 4.10-Task-Notes
- 4.11-Subtasks