🚀 SprintRecap: Jira Integration Setup Guide

First, you'll need to create an API token in your Jira account. This token will allow SprintRecap to securely access your Jira data.

1. Log in to your Atlassian account at id.atlassian.com
2. Navigate to Security → API tokens
3. Click "Create API token"
4. Give your token a descriptive name like "SprintRecap Integration"
5. Click "Create" and copy the generated token immediately

Screenshot placeholder:

Now you'll connect your Jira instance to SprintRecap using the API token you just created.

1. Log in to your SprintRecap dashboard
2. Navigate to Settings → Integrations
3. Click "Add Jira Integration"
4. Enter your Jira instance URL (e.g., yourcompany.atlassian.net)
5. Enter your Jira email address
6. Paste the API token you generated in Step 1
7. Click "Test Connection" to verify the setup
8. If successful, click "Save Integration"

Screenshot placeholder:

SprintRecap needs to understand your Jira field configuration to generate accurate reports.

1. In the integration settings, click "Load Jira Fields"
2. Select the Jira project(s) you want to include in reports
3. Wait for the field discovery process to complete
4. Review the detected fields and their types
5. Click "Confirm Field Mapping"

Configure which field SprintRecap should use to identify sprint assignments.

1. In the field mapping section, locate the "Sprint" field
2. If using standard Jira, this is usually Sprint
3. For custom configurations, select your sprint tracking field
4. Verify the field shows active sprints in the preview
5. Click "Set as Sprint Field"

Enhance your reports by mapping custom fields for additional insights.

1. Review the list of available custom fields
2. Select fields you want to include in reports
3. Configure field aliases for better report readability
4. Set up field value mappings if needed
5. Save your custom field configuration

Here's an example of what your final configuration might look like:

{
  "jira": {
    "baseUrl": "https://yourcompany.atlassian.net",
    "email": "your-email@company.com",
    "apiToken": "ATATT3xFfGF0...",
    "projects": ["PROJ", "TEAM"],
    "fieldMappings": {
      "sprint": "customfield_10020",
      "storyPoints": "customfield_10026",
      "epicLink": "customfield_10014",
      "priority": "priority",
      "labels": "labels",
      "components": "components"
    },
    "customFields": {
      "businessValue": "customfield_10100",
      "riskLevel": "customfield_10101",
      "customerImpact": "customfield_10102"
    }
  },
  "reportSettings": {
    "includeSubtasks": true,
    "excludeEpics": false,
    "timeZone": "America/New_York",
    "workingDays": ["monday", "tuesday", "wednesday", "thursday", "friday"]
  }
}