From 5e8ce932e6d465d7094844d194e865c79bb857ea Mon Sep 17 00:00:00 2001 From: Miguel de la Cruz Date: Thu, 24 Sep 2020 19:12:38 +0200 Subject: [PATCH] Update readme to include recent changes --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ee2bd45..bfae231 100644 --- a/README.md +++ b/README.md @@ -65,15 +65,30 @@ You can see more information on how each method works using `campaigner add --he Once the campaign is ready, we can see its status running `campaigner status`: ```sh +$ campaigner status Current campaign for johndoe/testrepo with summary Remove the ToDo comment in {{.filename}}:{{.lineNo}} - 351 total tickets - 0/351 published in Jira - 0/0 published in Github + 351 total tickets + 0 published in Jira + 0 published in Github + 0 assigned + 0 closed ``` The status shows the total of tickets that we have created, how many of those have been published in Jira and of that last amount, how many have been published in GitHub too. To publish tickets, you can use the `campaigner publish jira` and `campaigner publish github` commands, and you can publish tickets in batches or just publish all of them. When running a publish command, `campaigner` will search the first unpublished tickets and will use the provider APIs to publish them. + +### Syncing the campaign status + +If we want to check the status of our campaign as it progresses and the tickets get assigned and closed, we have first to sync our local state of the campaign with the status of the tickets we've published: + +```sh +$ campaigner sync +Updating ticket 9 of 9 +Synchronization completed +``` + +This will fetch the current state of the jira tickets and github issues and update our local campaign. Then we can run `campaigner status` to see the updated progress, or we can generate reports from the campaign's information with `campaigner report`.