toggl to jira

Alternar.track para Jira

É um pequeno aplicativo que pode ser executado manualmente ou via crontab. Este aplicativo exportará seu relatório toggl.track do período selecionado para os logs de trabalho do seu projeto Jira. Eu escrevi este aplicativo porque, do meu ponto de vista, a IU do log de trabalho do Jira não é útil. Você pode instalar a extensão do navegador toggl.track e isso será muito melhor do que o formulário de entrada "work-log" do Jira.

Requisitos

Como todo aplicativo, meu aplicativo também exige que algumas coisas sejam feitas antes da execução.

1. Você deve ter uma conta no Jira para poder criar o token de autenticação do Jira. Clique aqui para ver como.
2. Crie o token da API toggl.track. Clique aqui para ver como.

Instalação

1. Ir para a página de lançamentos
2. Baixe o arquivo chamado release.zip , descompacte-o e selecione o binário para o seu sistema operacional na pasta bin e copie-o para a pasta ~/toggl-to-jira no seu sistema. Claro, depende de você que tipo de pasta selecionar.
3. Certifique-se de que todas as variáveis ​​de ambiente necessárias foram definidas no .env
4. Usando a ferramenta de linha de comando, vá para ~/toggl-to-jira (ou seu caminho) e execute o seguinte comando:

    ./toggl-to-jira-{system}
   

   Observe que após iniciar o aplicativo tentará buscar as entradas de tempo da API toggl e enviá-las para a API Jira. No meu caso não havia registros de horário para colocar no Jira, então aqui está o que vi: Feito.

Configuração do ambiente

A recomendação é copiar o conteúdo de .env.example para o arquivo .env na pasta ~/toggl-to-jira (ou seu caminho)

Neste conteúdo fictício você pode ver as seguintes variáveis:

Para Toggl.track

• TOGGL_API_TOKEN – veja aqui como criar o token
• TOGGL_API_URL - o URL da API https://api.track.toggl.com
• TOGGL_DEFAULT_WORKSPACE_ID - basta acessar sua conta toggl.track e visitar a página de Relatórios, lá na URL do endereço você verá o ID. Aqui está um exemplo https://track.toggl.com/reports/summary/{WORKSPACE_ID}/period/thisWeek

Para Jira

• JIRA_APP_TOKEN - clique aqui para ver como gerar o token
• JIRA_EMAIL - e-mail da sua conta Jira
• JIRA_BASE_URL – o URL do espaço de trabalho https://sua-empresa.atlassian.net

Como funciona

A abordagem principal é:

1. Buscamos os dados da API toggl.track usando /reports/api/v2/details?workspace_id={workspace_id}&user_agent={user_agent}&since={date_from}&until={date_to}
2. Para cada entrada de tempo tentamos obter o número de minutos e enviar o registro de trabalho

Por favor, dê também uma olhada no diagrama do fluxograma:

Argumentos disponíveis

1. date_from – A data de início da exportação do filtro. Use o próximo formato: AAAA-MM-DD (padrão "2021-03-27")
2. date_to - A data final da exportação do filtro. Use o próximo formato: AAAA-MM-DD (padrão "2021-03-27")
3. workspace_id - O ID do espaço de trabalho que deve ser usado para a geração do relatório de dados toggl.track. Por padrão, será utilizado o ID da variável de ambiente TOGGL_DEFAULT_WORKSPACE_ID.

Por favor use --help para mais detalhes.

Quando o aplicativo ignora as entradas de tempo do toggl.track?

Existem condições quando o aplicativo ignora a entrada de hora recebida:

1. O aplicativo já processou a entrada de hora
2. Na descrição da entrada de tempo não foi possível encontrar a chave do Jira Task. O exemplo de chave de tarefa KEY-1100
3. O número de minutos gastos é menor que 1

Solução de problemas

Não é possível executar o aplicativo no MacOS Big Sur

1. Certifique-se de permitir a execução do aplicativo nas configurações Security & Privacy
2. Certifique-se de mover seu aplicativo para uma pasta fora das pastas básicas do sistema. Ex: ~/Downloads é uma pasta do sistema. Crie uma nova pasta em ~/ path e execute o aplicativo a partir daí.

Recebo o erro "Parece que há problemas com a configuração. Pare de executar o script" Por favor, certifique-se de definir todas as variáveis ​​de ambiente necessárias. Você pode encontrar a lista deles em .env.example .

Minha configuração

Eu recomendaria usar este aplicativo com a combinação da extensão do navegador toggl.track, que você pode encontrar aqui. E também recomendo definir o evento crontab para a execução do seu aplicativo, para que você não se importe mais com a sincronização do log de trabalho.

A mesma coisa que fiz no meu PC. Instalei o aplicativo no crontab para enviar o relatório Jira a cada 2 horas, para não bombardear as APIs Jira e Toggl.track. Além disso, em meu navegador instalei a extensão do navegador Toggl.track e habilitei nas configurações da extensão o suporte do Jira como na imagem abaixo: No final, para todas as tarefas no Jira tenho um botão para iniciar/parar o cronômetro e todas as minhas horas de trabalho ficam sincronizadas. É gratuito e muito útil.