Skip to content

feat: create cdp data issue reports in github instead of jira - #5056

Merged
joanagmaia merged 3 commits into
mainfrom
feat/issue-841-data-issue-github
Oct 20, 2026
Merged

joanagmaia merged 3 commits into
mainfrom
feat/issue-841-data-issue-github

Conversation

@joanagmaia

Copy link
Copy Markdown
Contributor

Summary

Jira is retired, but "Report data issue" on members and organizations still created a [Data Issue] … ticket there. Reports now go to linuxfoundation/lfx-cdp-insights-ops as GitHub issues, using the same flow Insights uses for its internal copy of report-form issues.

Changes

  • New backend/src/services/helpers/githubIssueReporter.ts, mirroring Insights' createInternalIssue: GitHub App installation token, resolve project 30's Team/Status options before creating anything, create missing labels, create the issue, then add it to the project and set the fields with retries.
  • The project step is best-effort: if it still fails after retries, the error is logged with the issue URL and the report succeeds. A failure before the issue exists fails the request, is logged, and the user gets the existing error toast.
  • DataIssueService keeps the same title ([Data Issue] <name> (<Member|Organization>)) and the same sections (entity, profile link, data issue, description, reporter), now as markdown. Labels: product-support, needs-triage, data-issue. dataIssues.issueUrl now stores the GitHub html_url instead of Jira's API self URL.
  • Reuses the existing CROWD_GITHUB_ISSUE_REPORTER_APP_ID / _PRIVATE_KEY / _INSTALLATION_ID vars, unused since the 2024 move to Jira (Migrate from GitHub support repo to Jira support board #2731). New repo, projectNumber, projectTeam, projectStatus settings default to linuxfoundation/lfx-cdp-insights-ops, 30, Data Quality / Support, Backlog, overridable with CROWD_GITHUB_ISSUE_REPORTER_REPO / _PROJECT_NUMBER / _PROJECT_TEAM / _PROJECT_STATUS.
  • Removed the Jira reporter: jiraIssueReporter config and env vars, JIRA_ISSUE_REPORTER_CONFIG, IJiraIssueReporterConfiguration, and the ADF helpers in services/libs/common/src/jira.ts (only used here). The Jira activity integration is untouched.

Deploy notes: the GitHub reporter credentials need to be set per environment, and the app needs Issues (read/write) on lfx-cdp-insights-ops, Metadata (read) and organization Projects (read/write) on linuxfoundation. The CROWD_JIRA_ISSUE_REPORTER_* secrets can be removed after deploy.

Type of change

  • Bug fix
  • New feature
  • Refactor / cleanup
  • Performance improvement
  • Chore / dependency update
  • Documentation

Related issue

Closes linuxfoundation/lfx-cdp-insights-ops#841

Refs linuxfoundation/lfx-cdp-insights-ops#841

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI balanced review requested due to automatic review settings October 20, 2026 13:04
@cursor

cursor Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

PR Summary

Medium Risk
Changes external ticketing for user-submitted data issues and depends on GitHub App credentials and project configuration; failures before issue creation block reports.

Overview
Data issue reports from member/organization flows no longer create Jira tasks; they open GitHub issues in the configured ops repo via a new createInternalIssue helper (GitHub App auth, optional label creation, issue creation, then GitHub Project v2 Team/Status assignment with retries).

DataIssueService keeps the same title and section content as markdown, adds labels product-support, needs-triage, and data-issue, and persists the GitHub html_url in issueUrl. Misconfigured project fields fail before an issue is created; project add failures are logged but the report still succeeds.

Config/types cleanup: jiraIssueReporter and JIRA_ISSUE_REPORTER_* are removed; githubIssueReporter gains repo, projectNumber, projectTeam, and projectStatus (with defaults and env overrides). Jira ADF helpers in services/libs/common/src/jira.ts are deleted.

Reviewed by Cursor Bugbot for commit 1792a55. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The GitHub App and Projects workflow still needs end-to-end verification with deployed credentials and permissions.

No open issues 🎉

What changed in this PR

Moves member and organization data-issue reports from retired Jira support to GitHub.

Changes:

  • Adds GitHub App authentication, issue labels, and project updates with retries.
  • Preserves report content and stores the GitHub issue URL.
  • Replaces Jira reporter configuration and removes unused helpers.
File Description
services/​libs/​types/​src/​dataIssues.ts Replaces Jira configuration types with GitHub project settings.
services/​libs/​common/​src/​jira.ts Removes Jira document helpers.
services/​libs/​common/​src/​index.ts Removes the Jira helper export.
backend/​src/​services/​helpers/​githubIssueReporter.ts Creates GitHub issues and updates project fields.
backend/​src/​services/​dataIssueService.ts Sends Markdown reports to GitHub.
backend/​src/​conf/​index.ts Removes Jira reporter configuration exports.
backend/​config/​default.json Sets default GitHub repository and project settings.
backend/​config/​custom-environment-variables.json Replaces Jira variables with GitHub settings.

Review effort: Balanced

@greptile-apps

greptile-apps Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The PR appears safe to merge with the documented GitHub App credentials and permissions.

Summary

Moves member and organization data reports from Jira to GitHub.

  • Member and organization data issue reports now create GitHub issues.

The earlier comment-style finding is fixed. joanagmaia accepted the risk of omitting new tests because they are not required here, the helper mirrors Insights, and a deployed end-to-end check is planned. Greptile withdrew that suggestion.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart TD
  A[Data issue report] --> B[Get GitHub App token]
  B --> C[Check project fields and options]
  C --> D[Ensure labels exist]
  D --> E[Create GitHub issue]
  E --> F[Retry project updates]
  F -->|Success| H[Save issue URL]
  F -->|Retries exhausted| G[Log error with issue URL]
  G --> H
  H --> I[Return saved report]
Loading

Reviews (3) · Last reviewed commit: "Merge branch 'main' into feat/issue-841-..." · Reviewed by Greptile

Comment thread backend/src/services/helpers/githubIssueReporter.ts Outdated
Comment thread backend/src/services/helpers/githubIssueReporter.ts
Refs linuxfoundation/lfx-cdp-insights-ops#841

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI balanced review requested due to automatic review settings October 20, 2026 13:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

GitHub App permissions and project assignment still need end-to-end verification before approval.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 20, 2026 13:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The new reporting workflow needs authenticated integration validation of GitHub App permissions and project-field compatibility.

No open issues 🎉

Review effort: Balanced

@joanagmaia
joanagmaia merged commit a17d40a into main Oct 20, 2026
16 checks passed
@joanagmaia
joanagmaia deleted the feat/issue-841-data-issue-github branch October 20, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants