admrene/npm-its-doc
1
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity
Files
fae1771c61ef297e8585484fadfe10744661800a
npm-its-doc/README.md
T
admrene fae1771c61 feat(workflow): automate Jira summary pipeline with optional Xray/Sonar links and solution version 
- add npm workflow to fetch recent Jira issues, summarize them, and create a target Jira ticket
- generate HTML report and optional SMTP email output
- add Docker runtime and TeamCity runner scripts (sh/ps1)
- support optional SOLUTION_VERSION, XRAY_REPORT_URL, SONAR_REPORT_URL
- map SOLUTION_VERSION to Jira fixVersions on ticket creation
- update README and .env.example with new configuration
2026-03-19 13:11:02 +01:00

2.5 KiB
Raw Blame History

Jira Workflow Automation (NPM + Docker + TeamCity)

Dieses Projekt automatisiert folgenden Ablauf:

  1. Letzte Jira Tickets anhand einer JQL abfragen.
  2. Zusammenfassung erzeugen (Status-Verteilung + Ticketliste).
  3. Neues Jira Ticket in einem anderen Projekt/Board erstellen.
  4. Optional Xray/Sonar Links und Loesungsversion in den Report aufnehmen.
  5. HTML-Report erzeugen und optional per E-Mail versenden.

Voraussetzungen

  • Node.js 20+
  • Docker
  • Jira Cloud API Token
  • Optional: SMTP Zugangsdaten fuer Mailversand

Lokaler Start

npm install
cp .env.example .env
npm run dry-run

Wenn alles passt:

npm start

Wichtige Umgebungsvariablen

Pflicht:

  • JIRA_BASE_URL
  • JIRA_USER_EMAIL
  • JIRA_API_TOKEN
  • JIRA_TARGET_PROJECT_KEY oder JIRA_TARGET_BOARD_ID

Empfohlen:

  • JIRA_SOURCE_JQL (z. B. project = SRC ORDER BY updated DESC)
  • JIRA_SOURCE_MAX_RESULTS (Default: 10)
  • JIRA_TARGET_ISSUE_TYPE (Default: Task)
  • JIRA_TARGET_SUMMARY_PREFIX (Default: Automatischer Jira Report)
  • JIRA_TARGET_LABELS (CSV)
  • SOLUTION_VERSION (setzt auch fixVersions im Jira Ticket)
  • XRAY_REPORT_URL (optional)
  • SONAR_REPORT_URL (optional)
  • JIRA_DRY_RUN (true/false)
  • OUTPUT_HTML_PATH (Default: report-output/report.html)

SMTP optional:

  • SMTP_ENABLED=true
  • SMTP_HOST, SMTP_PORT, SMTP_SECURE
  • SMTP_USER, SMTP_PASS
  • SMTP_FROM, SMTP_TO
  • SMTP_SUBJECT_PREFIX

Docker Nutzung

Image bauen:

docker build -t its-workflow-npm:local .

Container starten:

docker run --rm --env-file .env -v "$(pwd)/report-output:/app/report-output" its-workflow-npm:local

TeamCity Integration

Empfohlene Build Steps:

  1. Command Line (Linux Agent):
    • Script: sh teamcity/run-workflow.sh
  2. Alternativ PowerShell (Windows Agent):
    • Script file: teamcity/run-workflow.ps1

Lege in TeamCity die Variablen als Parameter vom Typ env.* an, z. B.:

  • env.JIRA_BASE_URL
  • env.JIRA_USER_EMAIL
  • env.JIRA_API_TOKEN (als Password Parameter)
  • env.JIRA_SOURCE_JQL
  • env.JIRA_TARGET_PROJECT_KEY
  • env.SOLUTION_VERSION
  • env.XRAY_REPORT_URL
  • env.SONAR_REPORT_URL
  • env.SMTP_ENABLED
  • env.SMTP_HOST ...

Der Report wird im Build-Workspace unter report-output/report.html abgelegt und kann als Build Artifact publiziert werden.

Ablauf im Fehlerfall

  • Jira API Fehler werden mit Antwortdetails ausgegeben.
  • Bei SMTP_ENABLED=true ohne vollstaendige SMTP Daten wird der Lauf abgebrochen.
  • Bei JIRA_DRY_RUN=true wird kein Ticket erstellt, aber Report + optional Mail erzeugt.
Reference in New Issue View Git Blame Copy Permalink