campaigner/README.md
2020-02-29 14:30:59 +01:00

39 lines
1.2 KiB
Markdown

# Campaigner
Command line tool to create and manage community campaigns.
## Usage
```sh
$ campaigner --help
Create and manage Open Source campaigns
Usage:
campaigner [command]
Available Commands:
add Adds tickets to the campaign
filter Interactively filters the current ticket list
help Help about any command
init Creates a new campaign in the current directory
token Subcommands related to tokens
Flags:
-h, --help help for campaigner
Use "campaigner [command] --help" for more information about a command.
```
## Application flow
1. Run `campaigner set-token` to set the tokens for `jira/github`.
2. Run `campaigner create` to create a new community campaign.
3. Run `campaigner add` to add new tickets based either on a `grep/ag`
command or a `govet` check.
4. Run `campaigner state` to see the status of each one of the
tickets. The tickets can be in an `unpublished`, `jira`, `github`
and `completed` state.
5. Run `campaigner template` to edit the ticket template.
6. Run `campaigner publish` to create the tickets in `jira` based on
the template.
7. Possible next step to publish the tickets from `jira` to `github`.