> For the complete documentation index, see [llms.txt](https://docs.sealights.io/knowledgebase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/user-story-coverage.md).

# User Story Coverage

User Story Coverage connects your issue tracker with SeaLights coverage data. It measures coverage by user story, feature, or sprint.

Coverage at the story level gives development and QA a shared, transparent view of quality throughout the release cycle, so teams catch gaps before release instead of after. Watch the [2-minute overview video](https://youtu.be/CQWcrIYS8pc) for the business case behind this feature.

**Audience:**

Development and QA teams use this together to keep coverage visibility shared across the team, rather than siloed in one role:

* DevOps engineers automating test coverage reporting in CI/CD pipelines
* QA engineers monitoring test coverage for specific user stories and features
* Engineering managers tracking team-level coverage metrics across sprints
* Release managers confirming adequate test coverage before production releases

### What it does

It helps you:

* extract ticket IDs from source control activity
* tag code changes in SeaLights
* generate coverage reports for stories and work items
* push coverage results back to Jira or Azure DevOps

### When to use it

Use this section when you want to:

* report sprint coverage for completed stories
* track coverage for pull requests or merged changes
* publish story-level coverage to Jira, Azure DevOps, or Confluence
* automate coverage reporting in CI/CD

### How it works

The workflow has two phases:

1. **Source tagging** — optional when SeaLights auto-tagging is enabled
2. **Reporting** — always required to generate and publish coverage results

#### Key benefits

* **Quality visibility** — insight into coverage at the user story level across every test stage, not just at the build level
* **Cross-team collaboration** — gives development and QA a shared, transparent view of coverage, reducing the risk of undetected defects reaching production
* **Traceability** — direct linkage between user stories and test coverage
* **Automation** — eliminates manual coverage reporting
* **Flexibility** — supports GitHub, GitLab, Bitbucket, and Azure DevOps Git
* **Multi-format reporting** — HTML, Confluence, JSON, and direct issue-tracker updates

{% hint style="info" %}
If your builds already report git commit data to SeaLights and auto-tagging is enabled, you can skip the manual `US_SRC_*` tagging scripts.
{% endhint %}

### Choose your path

#### Core workflow

Use this order for most teams:

1. [Installation and first run](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/installation.md)
2. [Configuration](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/configuration.md)
3. [Deployment patterns](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/examples.md)
4. [Security Considerations](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/security-considerations.md)

Use **Installation and first run** for the first working setup.

Use **Configuration** and **Deployment patterns** for the advanced flows.

#### By job to be done

Use these entry points when you already know what you need:

* [Installation and first run](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/installation.md) — get the first report working quickly
* [Configuration](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/configuration.md) — define inputs, scope, and publication targets
* [Deployment patterns](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/examples.md) — choose a delivery pattern for Jira, Azure DevOps, Confluence, or CI/CD
* [Security Considerations](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/security-considerations.md) — secure credentials, access, and automation
* [CLI Reference](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/cli-reference.md) — run the exact commands

#### Advanced

Use this when you need deeper reference or diagnostics.

* [CLI Reference](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/cli-reference.md)
* [Troubleshooting](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/troubleshooting.md)
* [FAQ](/knowledgebase/setup-and-configuration/integrations/user-story-coverage/faq.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/user-story-coverage.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.