From 26a3073d9bb0a301fa0078315b42c090ac968944 Mon Sep 17 00:00:00 2001 From: Carl Walsh Date: Thu, 8 Apr 2021 14:28:29 -0700 Subject: [PATCH] Add documentation for automated edits to the README I was trying to automate editing issues, but the README doesn't contain much information for that. Mention --noedit and --override, and how to customize additional fields. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2688c20d..4ab3486f 100644 --- a/README.md +++ b/README.md @@ -256,6 +256,14 @@ closes **go-jira** will submit the completed form. The order which **go-jira** * **EDITOR** environment variable * vim +To automate editing, use the `--noedit` to skip opening the editor, and pass `--override` fields as defined in `~/.jira.d/templates/edit`: + +``` +jira edit GOJIRA-321 --noedit --override priority=P0 +``` + +To edit fields not in the default template, [customize the template](https://github.com/go-jira/jira/issues/238#issuecomment-681666211). + ### Templates **go-jira** has the ability to customize most output (and editor input) via templates. There are default templates available for all operations,