|
| 1 | +.. _integrations_forgejo: |
| 2 | + |
| 3 | +Forgejo Integration |
| 4 | +=================== |
| 5 | + |
| 6 | +DejaCode's integration with Forgejo allows you to automatically forward |
| 7 | +**Workflow Requests** to Forgejo repository **Issues**. |
| 8 | +This behavior can be selectively applied to any **Request Template** of your choice. |
| 9 | + |
| 10 | +Prerequisites |
| 11 | +------------- |
| 12 | + |
| 13 | +- A **Forgejo repository** that you want to integrate with DejaCode. |
| 14 | +- A **Forgejo user account** with sufficient permissions (at least write access) to |
| 15 | + create and manage issues in that repository. |
| 16 | + |
| 17 | +Forgejo Access Token |
| 18 | +-------------------- |
| 19 | + |
| 20 | +To enable integration, you need a **personal access token** from Forgejo. |
| 21 | + |
| 22 | +1. **Generate a Token**: |
| 23 | + |
| 24 | + - Log into your Forgejo instance |
| 25 | + - Go to your **User settings** → **Applications** → **Generate New Token** |
| 26 | + - Set a clear name like ``DejaCode Integration`` |
| 27 | + - Select **permissions**: |
| 28 | + |
| 29 | + - ``issue: Read and write``: Create and update issues |
| 30 | + |
| 31 | + - Generate the token and copy it securely |
| 32 | + |
| 33 | +.. note:: |
| 34 | + |
| 35 | + It is recommended to **create a dedicated Forgejo user** such as |
| 36 | + ``dejacode-integration`` to manage automated activity for better traceability. |
| 37 | + |
| 38 | +DejaCode Dataspace Configuration |
| 39 | +-------------------------------- |
| 40 | + |
| 41 | +To use your Forgejo token in DejaCode: |
| 42 | + |
| 43 | +1. Go to the **Administration dashboard** |
| 44 | +2. Navigate to **Dataspaces**, and select your Dataspace |
| 45 | +3. Scroll to the **Forgejo Integration** section under **Configuration** |
| 46 | +4. Paste your Forgejo token in the **Forgejo token** field |
| 47 | +5. Save the form |
| 48 | + |
| 49 | +Activate Forgejo Integration on Request Templates |
| 50 | +------------------------------------------------- |
| 51 | + |
| 52 | +1. Go to the **Administration dashboard** |
| 53 | +2. Navigate to **Workflow** > **Request templates** |
| 54 | +3. Create or edit a Request Template in your Dataspace |
| 55 | +4. Set the **Issue Tracker ID** field to your Forgejo repository URL, e.g.:: |
| 56 | + |
| 57 | + https://forgejo.example.org/org/repo_name |
| 58 | + |
| 59 | +Once the integration is configured: |
| 60 | + |
| 61 | +- New **Requests** using this template will be automatically pushed to Forgejo |
| 62 | +- Field updates (like title or priority) and **status changes** (e.g. closed) will be |
| 63 | + synced |
| 64 | +- New **Comments** on a DejaCode Request will be propagated to the Forgejo Issue. |
0 commit comments