Repository navigation
feat: create cdp data issue reports in github instead of jira - #5056
Conversation
Refs linuxfoundation/lfx-cdp-insights-ops#841 Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
PR SummaryMedium Risk Overview
Config/types cleanup: Reviewed by Cursor Bugbot for commit 1792a55. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
🔵 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
[Medium impact] The PR appears safe to merge with the documented GitHub App credentials and permissions. SummaryMoves member and organization data reports from Jira to GitHub.
The earlier comment-style finding is fixed.
|
Refs linuxfoundation/lfx-cdp-insights-ops#841 Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Summary
Jira is retired, but "Report data issue" on members and organizations still created a
[Data Issue] …ticket there. Reports now go tolinuxfoundation/lfx-cdp-insights-opsas GitHub issues, using the same flow Insights uses for its internal copy of report-form issues.Changes
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.DataIssueServicekeeps 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.issueUrlnow stores the GitHubhtml_urlinstead of Jira's APIselfURL.CROWD_GITHUB_ISSUE_REPORTER_APP_ID/_PRIVATE_KEY/_INSTALLATION_IDvars, unused since the 2024 move to Jira (Migrate from GitHub support repo to Jira support board #2731). Newrepo,projectNumber,projectTeam,projectStatussettings default tolinuxfoundation/lfx-cdp-insights-ops,30,Data Quality / Support,Backlog, overridable withCROWD_GITHUB_ISSUE_REPORTER_REPO/_PROJECT_NUMBER/_PROJECT_TEAM/_PROJECT_STATUS.jiraIssueReporterconfig and env vars,JIRA_ISSUE_REPORTER_CONFIG,IJiraIssueReporterConfiguration, and the ADF helpers inservices/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) onlinuxfoundation. TheCROWD_JIRA_ISSUE_REPORTER_*secrets can be removed after deploy.Type of change
Related issue
Closes linuxfoundation/lfx-cdp-insights-ops#841