> For the complete documentation index, see [llms.txt](https://sealights-docs.tricentis.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sealights-docs.tricentis.com/user-story-coverage/technical-overview/deployment-guide.md).

# 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/s7NERxkTOEI79NbEor7t" %}
[US1\_getResults.sh](/user-story-coverage/technical-overview/deployment-guide/us1_getresults.sh.md)
{% endcontent-ref %}

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

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