campaigner/README.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2020-02-28 23:34:24 +01:00
# Campaigner
2020-03-07 12:11:52 +01:00
Command line tool to create and manage community campaigns. `campaigner` takes care of all the campaign lifecycle, starting with getting information to generate the tickets, then publishing them in jira and github and finally tracking their status, the campaign progress and generating reports.
- `campaigner init` generates the campaign file, linking it to the jira instance and github repository and to the epic issue that will host each campaign ticket.
- `campaigner add` parses information from different sources and uses it to generate tickets for the campaign.
- `campaigner publish` builds the tickets information and publishes it both to jira and github.
- `campaigner sync` downloads updated information of the campaign progress.
- `campaigner status` shows the current campaign data and progression.
- `campaigner report` generates reports from the campaign data.
2020-02-28 23:34:24 +01:00
2020-02-29 01:22:11 +01:00
## Usage
```sh
$ campaigner --help
Create and manage Open Source campaigns
Usage:
campaigner [command]
Available Commands:
2020-03-01 11:43:31 +01:00
add Adds tickets to the campaign from the output of grep/ag/govet
filter Interactively filters the current ticket list
2020-02-29 01:22:11 +01:00
help Help about any command
init Creates a new campaign in the current directory
2020-03-04 23:09:32 +01:00
publish Publishes the campaign tickets in different providers
2020-03-01 11:43:31 +01:00
standalone Standalone fire-and-forget commands
2020-03-07 12:11:52 +01:00
status Prints the current status of the campaign
2020-03-04 23:09:32 +01:00
sync Synchronizes the status of the tickets with remote providers
2020-02-29 01:22:11 +01:00
token Subcommands related to tokens
Flags:
-h, --help help for campaigner
Use "campaigner [command] --help" for more information about a command.
```