# Deployment Guide

### Requirements

1. **Data Integration:**
   * **Ticket Identification:** Seamlessly link code commits to corresponding Jira tickets. Ideally, leverage the most common approach of developers specifying ticket IDs in their git commit comments.
   * **Critical Code Flag:** Provide an optional mechanism within commit comments to highlight critical code by simply mentioning "Critical", enabling focused analysis and prioritization.
2. **Data Processing and Report Design:**
   * **Data Integration Strategy:** Design and plan the report layout based on data structures from Jira, Git, and SeaLights. Consider visualization approaches for effective information presentation.
   * **Script Implementation:** Develop a script to process and analyze the integrated data, generating the desired report format.
3. **Deployment and Access:**
   * **Execution Environment:** Determine the most suitable location for script execution within the customer's environment, considering security, flexibility, and scalability.
   * **Data Access:** Ensure the script has access to:
     * Git repositories linked to the relevant user stories.
     * Git commands for efficient data retrieval and manipulation.
     * Jira API for pulling ticket information.
     * SeaLights API for accessing coverage data.

***

### Scripts

**Get Started Quickly with Customizable Scripts:** Streamline your work with these scripts and follow the instructions to personalize them for optimal efficiency.

{% content-ref url="/pages/xMmKaWMmFgag0IaHkf5l" %}
[US1\_getResults.sh](/knowledgebase/guides/user-story-coverage/technical-overview/deployment-guide/us1_getresults.sh.md)
{% endcontent-ref %}

{% content-ref url="/pages/hDpqkf53jWUIXGINWubi" %}
[US2\_createReport.sh](/knowledgebase/guides/user-story-coverage/technical-overview/deployment-guide/us2_createreport.sh.md)
{% endcontent-ref %}

{% content-ref url="/pages/xKWWfFRwEnyjZ1YpijHl" %}
[US\_UpdateConfluence.sh](/knowledgebase/guides/user-story-coverage/technical-overview/deployment-guide/us_updateconfluence.sh.md)
{% endcontent-ref %}


---

# Agent Instructions: 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:

```
GET https://docs.sealights.io/knowledgebase/guides/user-story-coverage/technical-overview/deployment-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.