gabor-boros/minutes

View on GitHub
www/docs/sources/tempo.md

Summary

Maintainability
Test Coverage
Source documentation for [Tempo](https://tempo.io/).

## Field mappings

The source makes the following special mappings.

| From       | To      | Description                                                                                                                                         |
| ---------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| AccountKey | Client  |                                                                                                                                                     |
| ProjectKey | Project | Tasks will be used for defining the summary of an entry; in case the `tags-as-tasks-regex` is set, Summary will be set to the Description of the item |
| IssueKey   | Task    |                                                                                                                                                     |
| Comment    | Notes   |                                                                                                                                                     |

## CLI flags

The source provides to following extra CLI flags.

```plaintext
Flags:
    --tempo-password string        set the login password
    --tempo-url string             set the base URL
    --tempo-username string        set the login user ID
```

## Configuration options

The source provides the following extra configuration options.

| Config option  | Kind   | Description                                            | Example                                     |
| -------------- | ------ | ------------------------------------------------------ | ------------------------------------------- |
| tempo-password | string | Jira password                                          | tempo-password = "<SECRET>"                 |
| tempo-url      | string | URL for the Jira installation without a trailing slash | tempo-url = "https://example.atlassian.net" |
| tempo-username | string | Jira username                                          | tempo-username = "gabor-boros"              |

## Limitations

No known limitations.

## Example configuration

!!! warning

    At the moment only one target is supported, Tempo, hence tempo cannot be used as a source yet.

```toml
# Source config
source = "tempo"
source-user = "<jira username>"

# Target config
target = "<TARGET>"
target-user = "<jira username>"

# Tempo config
tempo-url = "https://<org>.atlassian.net"
tempo-username = "<jira username>"
tempo-password = "<jira password>"

# General config
tags-as-tasks-regex = '[A-Z]{2,7}-\d{1,6}'
round-to-closest-minute = true
force-billed-duration = true
```