Skip to content

Commit 15067d4

Browse files
tg666tg666
committed
Updated README and CHANGELOG
1 parent 98578a1 commit 15067d4

File tree

2 files changed

+42
-13
lines changed

2 files changed

+42
-13
lines changed

‎CHANGELOG.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- Added row with totals to the summary table.
13+
- Added the option `--filter` with supported filters `issueCode=<value>`, `workspaceId=<value>`, `workspaceName=<value>`, `projectId=<value>` and `projectName=<value>`.
14+
15+
### Removed
16+
17+
- Removed the option `--issue`.
18+
1019
## [1.1.0] - 2023-04-25
1120

1221
### Added
1322

14-
- Added PHPStan on level 8
15-
- Added GitHub actions - PHPStan, Php-Cs-Fixer and Docker image build
23+
- Added PHPStan on level 8.
24+
- Added GitHub actions - PHPStan, Php-Cs-Fixer and Docker image build.
1625
- Added the option `--append`. All entries from Toggl are synchronized without creating a diff if the mode `--append` is enabled. Will cause duplicates if the command is run multiple times for the same day.
1726

1827
### Changed

‎README.md

+31-11
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,21 @@ $ make
5656
Synchronization is started with:
5757

5858
```sh
59-
$ docker exec -it t2j-app bin/console sync --start <START_DATE> --end <END_DATE> [--group-by-day] [--rounding <ROUNDING>] [--issue <ISSUE_CODE>] [--dry-run] [--no-interaction]
59+
$ docker exec -it t2j-app bin/console sync --start <START_DATE> --end <END_DATE> [--group-by-day] [--rounding <ROUNDING>] [--filter <FILTER_NAME=FILTER_VALUE>] [--dry-run] [--no-interaction]
6060
```
6161

6262
## Available Options
6363

64-
| Option | Type | Description |
65-
|--------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------|
66-
| `--start` | String | Accepts datetime strings - absolute or relative, default: `yesterday` |
67-
| `--end` | String | Accepts datetime strings - absolute or relative, default: `yesterday` |
68-
| `--group-by-day` | Boolean | Group all daily entries into one (per issue) |
69-
| `--append` | Boolean | All entries will be added without creating a diff. Will cause duplicates if the command is run multiple times on the same day |
70-
| `--rounding` | Integer | All entries will be rounded to up the given minutes [2-60] |
71-
| `--issue` | String | Issue code to be synchronized. Multiple values can be declared. If the option is omitted then all entries are synchronized |
72-
| `--dry-run` | Boolean | Displays only change set and summary tables but do not synchronize anything |
73-
| `-n`, `--no-interaction` | Boolean | Do not ask any interactive question, suitable for scheduled commands, etc. |
64+
| Option | Type | Description |
65+
|--------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
66+
| `--start` | String | Accepts datetime strings - absolute or relative, default: `yesterday` |
67+
| `--end` | String | Accepts datetime strings - absolute or relative, default: `yesterday` |
68+
| `--group-by-day` | Boolean | Group all daily entries into one (per issue) |
69+
| `--append` | Boolean | All entries will be added without creating a diff. Will cause duplicates if the command is run multiple times on the same day |
70+
| `--rounding` | Integer | All entries will be rounded to up the given minutes [2-60] |
71+
| `--filter` | String | Filter in the format "filterName=filterValue" that entries must meet for synchronization. Multiple values can be declared, between filters with the same name is OR, between filters with different names is AND. |
72+
| `--dry-run` | Boolean | Displays only change set and summary tables but do not synchronize anything |
73+
| `-n`, `--no-interaction` | Boolean | Do not ask any interactive question, suitable for scheduled commands, etc. |
7474

7575
## Description format
7676

@@ -87,6 +87,26 @@ For example, if the issue in Jira has code `PROJ-123` and the name of the issue
8787
- `PROJ-123 UX improvements Fixed footer on small devices` - the entry is imported with a comment `Fixed footer on small devices`
8888
- `PROJ-123 Fixed footer on small devices` - the entry is imported with a comment `Fixed footer on small devices`
8989

90+
## Supported filters
91+
92+
- `issueCode`
93+
- `workspaceId`
94+
- `workspaceName`
95+
- `projectId`
96+
- `projectName`
97+
98+
### Filters example
99+
100+
Entries must be in the project "Demo" or "Demo2":
101+
```
102+
--filter "projectName=Demo" --filter="projectName=Demo2"
103+
```
104+
105+
Entries must be in the workspace "My company" and must have the issue code "PROJ-123":
106+
```
107+
--filter "workspaceName=My company" --filter="issueCode=PROJ-123"
108+
```
109+
90110
## Limitations
91111

92112
Depending on the range of the synchronization interval (start/end), you may run into the limits of one of the APIs. Therefore, we recommend running synchronization e.g. every day/sprint/month, etc.

0 commit comments

Comments
 (0)