From 35fec8bba2d653e681cfb1bd0f33a903290d8b10 Mon Sep 17 00:00:00 2001 From: "feliks.pobiedzinski@swmansion.com" Date: Sat, 14 Oct 2023 15:19:04 +0200 Subject: [PATCH] Add more descritpion, what get_ticket_id.exs does --- scripts/get_ticket_id.exs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/scripts/get_ticket_id.exs b/scripts/get_ticket_id.exs index 4172d5b0f..5acc0ea61 100644 --- a/scripts/get_ticket_id.exs +++ b/scripts/get_ticket_id.exs @@ -1,5 +1,14 @@ # This script is used by .github/actions/close_issue/action.yml and it shouldn't be used in any other places. +# It expects: +# - output from `$ gh project item-list --owner --format json --limit ` command +# on standard input +# - URL of issue, that corresponds to one of the tickets included in the JSON data returned from the command +# above. This URL should be passed as an argument in argv +# And prints `TICKET_ID ` on standard output, where `` is id of a project item corresponding to the +# issue with the specified URL. Note, that beyond this, stdout can also contain some logs from `Mix.install/1`, +# e.g. `Resolving Hex dependencies...`. + Mix.install(json: "~> 1.4.1") [issue_url] = System.argv()