Skip to content

Instantly share code, notes, and snippets.

@AKLutterbach
Last active January 17, 2026 15:27
Show Gist options
  • Select an option

  • Save AKLutterbach/d030784aa0c6e0af1efa76606090bfde to your computer and use it in GitHub Desktop.

Select an option

Save AKLutterbach/d030784aa0c6e0af1efa76606090bfde to your computer and use it in GitHub Desktop.
Sprint Weekly – Documentation

Sprint Weekly

Clear, shareable sprint reports for Jira Cloud.

Table of Contents

Overview

Key Features

Requirements

Installation

Using Sprint Weekly

Generating a Report

Handling Empty States

Support and Contact

Versioning and Updates

Privacy and Data

Overview

Sprint Weekly is a Jira Cloud app that generates clean, readable sprint reports for team leads, project managers, and stakeholders. Select a project and sprint, customize which metrics and sections to include, and export a PDF summary in seconds. The app is designed for teams who need to share sprint progress with clients, leadership, or cross-functional partners without requiring direct access to Jira.

Key Features

Project and sprint selection – Choose any accessible project and sprint from dropdown menus in the app.

Core sprint metrics – View summary cards showing committed work, completed issues, carryover from previous sprints, and mid-sprint additions.

Issue tables – Browse detailed lists of completed and incomplete issues, grouped by status.

Customizable report sections – Toggle report sections on or off to tailor the output for your audience.

One-click PDF export – Download a formatted PDF report that includes all selected metrics and issue details.

Theme support – Works in both light and dark Jira themes.

Requirements

Jira Cloud – Sprint Weekly is built on Atlassian Forge and runs exclusively on Jira Cloud.

Project access – Users must have permission to view the selected project and its sprints in Jira.

Sprint data – The app reads sprint information from Jira Software boards; projects must use sprints to generate reports.

Permissions

Sprint Weekly requires the following Jira permissions to function:

Read access to projects, issues, and sprint data.

Access to issue details including status, assignee, summary, and custom fields (such as story points).

These permissions are requested during installation and managed by your Jira administrator.

Installation

Install from the Atlassian Marketplace

Visit the Sprint Weekly listing on the Atlassian Marketplace.

Click Get it now and select your Jira Cloud site.

Review and approve the requested permissions.

Access the app

After installation, navigate to the Apps menu in the top navigation bar of Jira.

Select Sprint Weekly from the dropdown.

Alternatively, find Sprint Weekly in the project sidebar under the Apps section (if configured there).

Confirm permissions

Ensure your Jira administrator has approved the app permissions.

Users need view access to the projects and sprints they want to report on.

Using Sprint Weekly Generating a Report

Select a project

Open Sprint Weekly from the Apps menu or project sidebar.

Choose a project from the Project dropdown.

If no projects appear, verify you have view access to at least one Jira project.

Select a sprint

After selecting a project, choose a sprint from the Sprint dropdown.

Sprints are listed with their current state (active, closed, or future).

If no sprints are available, ensure the selected project uses Jira Software boards with sprints configured.

Customize report options

Use the toggle controls to enable or disable specific report sections.

Adjust which metrics and issue tables appear in the final output.

Changes are reflected in the report preview.

Generate the report

Click the Generate report button to build the sprint summary.

The app retrieves issue data and calculates metrics automatically.

Export as PDF

Click the Export PDF button in the top-right corner of the report.

The PDF includes all visible sections and metrics from the current report.

The file name typically follows the format: [Project Name]-Report-[Timestamp].pdf.

Handling Empty States

No projects available – If the project dropdown is empty, verify that you have view access to Jira projects on your site.

No sprints available – If the sprint dropdown is empty after selecting a project, ensure the project has active or closed sprints configured.

No issues in sprint – If a sprint has no committed or completed issues, the report will display empty tables with clear messages.

Support and Contact

If you encounter issues or have questions about Sprint Weekly, please contact:

Email: support@datainsightlab.co

When reaching out, please include:

Your Jira Cloud site URL (for example, yourcompany.atlassian.net)

The version of Sprint Weekly you are using (visible in the Manage apps section of Jira)

A brief description of the issue or question, including steps to reproduce and any error messages

Support hours (ET): Monday to Friday, 9:00 AM to 5:00 PM Support requests can be submitted at any time. Responses outside support hours are best-effort.

Target initial response times:

Critical (app unavailable or severe impact): within 2 business days

High (core functionality impaired): within 2 business days

Normal (general issue or question): within 3 business days

Low / Feature requests: within 5 business days

These are target initial response times. Resolution time may vary based on issue complexity and Jira Cloud platform behavior.

Versioning and Updates

Sprint Weekly receives updates with new features, performance improvements, and bug fixes. Updates are deployed automatically to your Jira Cloud site; no manual action is required.

You can view the current version in the Manage apps section of Jira, or check the Marketplace listing for the latest changelog.

Privacy and Data

Sprint Weekly reads issue and sprint data from your selected Jira projects in order to generate reports. All data processing occurs within the Atlassian Forge environment and remains within Atlassian infrastructure.

Data access – The app accesses project names, sprint details, issue summaries, statuses, assignees, and custom fields (such as story points) for the projects you select.

Temporary use – Data is used only to generate reports for the selected project and sprint.

No external storage – Sprint Weekly does not store your Jira issue content in external systems and does not sell or share Jira data with third parties for marketing or advertising purposes.

For details, see the Privacy Policy: https://gist.github.com/AKLutterbach/13f91c9d209e2c0ebbbcd7be8503c02f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment