Configuration

Configure data sources, analytics scope, and publication targets.

User Story Coverage uses JSON settings files with environment variable overrides. Build the configuration in three parts: data sources, analytics scope, and publication targets.

Use Installation and first run for the first working setup.

How configuration is organized

Use the child pages in this order:

1

Choose your data sources

Start with Data sources.

This page defines where User Story Coverage reads source data from.

Use it to choose:

• Jira or Azure DevOps as the ticket source
• JQL or WIQL queries
• SeaLights, Git, and SCM connection settings

2

Define the analytics scope

Then use Project analytics scope.

This page defines what coverage data is included in the result.

Use it to choose:

• which SeaLights apps are in scope
• which repositories are included
• which test stages or grouped stages are reported

3

Choose the publication targets

Finish with Publication targets.

This page defines where the output is published.

Use it to choose:

• Jira plugin, ADO plugin, or legacy Jira custom fields for KPIs
• Confluence for detailed reports
• target-specific publishing behavior and templates

Which page answers which question

Use these quick rules when you are not sure where a setting belongs:

• If you are asking where does the source data come from? — use Data sources
• If you are asking what coverage data is included? — use Project analytics scope
• If you are asking where do the results go? — use Publication targets

Configuration files

By default, scripts look for a file named settings in the current directory.

You can also pass one or more --settings files.

Use CLI Reference for exact command syntax and flag usage.

Multiple settings files

You can layer several settings files in one run.

Merge rules

• Single values are replaced by the last file.
• Arrays are appended.
• Objects are merged recursively.

Sample file

Start from settings.sample when you need a complete example.

Environment variables

All settings can be overridden with environment variables.

Environment variables always win over settings files.

Use Environment variables for the full variable table, JSON examples, and CI/CD patterns.

Shared settings

Output folder

Use output_folder to control where generated files are saved.

{
  "output_folder": "./reports"
}

Leave it empty to use the current directory.

Validation

Scripts validate configuration at startup.

Check these first when a run fails:

• missing required fields
• invalid regex patterns
• invalid URLs
• invalid JSON passed through environment variables

Best practices

• Split shared settings and secrets into different files.
• Prefer environment variables in CI/CD.
• Keep credentials out of version control.

Do not commit API tokens, passwords, or production credentials.

Use Security Considerations for credential, network, and CI/CD security practices.