toggl to jira

Toggle.track zu Jira

Es handelt sich um eine kleine Anwendung, die manuell oder über Crontab ausgeführt werden kann. Diese Anwendung exportiert Ihren toggl.track-Bericht für den ausgewählten Zeitraum in die Arbeitsprotokolle Ihres Jira-Projekts. Ich habe diese App geschrieben, weil die Jira-Arbeitsprotokoll-Benutzeroberfläche aus meiner Sicht nicht nützlich ist. Sie können die Browsererweiterung „toggl.track“ installieren und diese ist viel besser als das „Arbeitsprotokoll“-Eingabeformular von Jira.

Anforderungen

Wie jede Anwendung erfordert auch meine App einige Dinge, die vor der Ausführung erledigt werden müssen.

1. Sie müssen über ein Konto in Jira verfügen, damit Sie das Jira-Authentifizierungstoken erstellen können. Klicken Sie hier, um zu sehen, wie.
2. Erstellen Sie das API-Token toggl.track. Klicken Sie hier, um zu sehen, wie.

Installation

1. Gehen Sie zur Seite „Veröffentlichungen“.
2. Laden Sie das Archiv mit dem Namen release.zip herunter, entpacken Sie es, wählen Sie die Binärdatei für Ihr Betriebssystem aus dem Ordner bin aus und kopieren Sie sie in den Ordner ~/toggl-to-jira in Ihrem System. Natürlich bleibt es Ihnen überlassen, welche Art von Ordner Sie auswählen.
3. Stellen Sie sicher, dass alle erforderlichen Umgebungsvariablen in der .env festgelegt wurden
4. Gehen Sie mit dem Befehlszeilentool zu ~/toggl-to-jira (oder Ihrem Pfad) und führen Sie den folgenden Befehl aus:

    ./toggl-to-jira-{system}
   

   Bitte beachten Sie, dass die App nach dem Start versucht, die Zeiteinträge von der Toggl-API abzurufen und an die Jira-API zu senden. In meinem Fall gab es keine Zeiteinträge, die in Jira eingegeben werden mussten, also habe ich Folgendes gesehen:Erledigt.

Env-Konfiguration

Es wird empfohlen, den Inhalt von .env.example in die .env Datei im Ordner ~/toggl-to-jira (oder in Ihrem Pfad) zu kopieren

In diesem Dummy-Inhalt können Sie die folgenden Variablen sehen:

Für Toggl.track

• TOGGL_API_TOKEN – hier erfahren Sie, wie Sie das Token erstellen
• TOGGL_API_URL – die API-URL https://api.track.toggl.com
• TOGGL_DEFAULT_WORKSPACE_ID – Gehen Sie einfach zu Ihrem toggl.track-Konto und besuchen Sie die Seite „Berichte“. Dort sehen Sie in der Adress-URL die ID. Hier ist ein Beispiel: https://track.toggl.com/reports/summary/{WORKSPACE_ID}/period/thisWeek

Für Jira

• JIRA_APP_TOKEN – Klicken Sie hier, um zu sehen, wie das Token generiert wird
• JIRA_EMAIL – die E-Mail-Adresse Ihres Jira-Kontos
• JIRA_BASE_URL – die Arbeitsbereichs-URL https://your-company.atlassian.net

Wie es funktioniert

Der Hauptansatz ist:

1. Wir rufen die Daten von der toggl.track-API mit /reports/api/v2/details?workspace_id={workspace_id}&user_agent={user_agent}&since={date_from}&until={date_to}
2. Für jeden Zeiteintrag versuchen wir, die Anzahl der Minuten zu ermitteln und das Arbeitsprotokoll zu senden

Bitte schauen Sie sich auch das Flussdiagramm an:

Verfügbare Argumente

1. date_from – Das Startdatum für den Filterexport. Bitte verwenden Sie das nächste Format: JJJJ-MM-TT (Standard: 27.03.2021).
2. date_to – Das Enddatum für den Filterexport. Bitte verwenden Sie das nächste Format: JJJJ-MM-TT (Standard: 27.03.2021).
3. workspace_id – Die Arbeitsbereichs-ID, die für die Generierung des toggl.track-Datenberichts verwendet werden soll. Standardmäßig wird die ID der Umgebungsvariablen TOGGL_DEFAULT_WORKSPACE_ID verwendet.

Bitte verwenden Sie --help für weitere Details.

Wenn App Zeiteinträge von toggl.track ignoriert?

Es gibt Bedingungen, unter denen die Anwendung den empfangenen Zeiteintrag ignoriert:

1. Die App hat den Zeiteintrag bereits verarbeitet
2. In der Beschreibung des Zeiteintrags konnten wir den Jira-Task-Schlüssel nicht finden. Das Aufgabenschlüsselbeispiel KEY-1100
3. Die Anzahl der aufgewendeten Minuten ist kleiner als 1

Fehlerbehebung

Die App kann unter MacOS Big Sur nicht ausgeführt werden

1. Stellen Sie sicher, dass Sie die Ausführung der Anwendung in den Security & Privacy zulassen
2. Stellen Sie sicher, dass Sie Ihre Anwendung in einen Ordner außerhalb der Basissystemordner verschieben. Beispiel: ~/Downloads ist ein Systemordner. Erstellen Sie einen neuen Ordner in ~/ path und führen Sie die Anwendung von dort aus.

Ich erhalte die Fehlermeldung „Es sieht so aus, als gäbe es Probleme mit der Konfiguration. Stoppen Sie die Ausführung des Skripts.“ Bitte stellen Sie sicher, dass Sie alle erforderlichen Umgebungsvariablen definiert haben. Die Liste davon finden Sie in .env.example .

Mein Setup

Ich würde empfehlen, diese Anwendung in Kombination mit der Browsererweiterung toggl.track zu verwenden, die Sie hier finden. Außerdem würde ich empfehlen, das Crontab-Ereignis für die Ausführung Ihrer Anwendung festzulegen, damit Sie sich nicht mehr um die Synchronisierung des Arbeitsprotokolls kümmern müssen.

Das Gleiche habe ich auf meinem PC gemacht. Ich habe die App in crontab installiert, um den Jira-Bericht alle zwei Stunden zu senden, damit ich die APIs von Jira und Toggl.track nicht bombardiere. Außerdem habe ich in meinem Browser die Browsererweiterung Toggl.track installiert und in den Erweiterungseinstellungen die Jira-Unterstützung aktiviert, wie im Bild unten: Am Ende habe ich für alle Aufgaben in Jira eine Schaltfläche zum Starten/Stoppen des Timers und alle meine Arbeitsstunden sind synchron. Es ist kostenlos und sehr nützlich.