From 5b06f30df9f793307443a6b6a4e76533e93b7767 Mon Sep 17 00:00:00 2001 From: andrewlalis Date: Fri, 29 Apr 2022 09:32:18 +0200 Subject: [PATCH] Added more docs to the command-line interface. --- .../distribugit/cli/DistribuGitCommand.java | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/main/java/nl/andrewl/distribugit/cli/DistribuGitCommand.java b/src/main/java/nl/andrewl/distribugit/cli/DistribuGitCommand.java index ba3dcca..5d3a0d8 100644 --- a/src/main/java/nl/andrewl/distribugit/cli/DistribuGitCommand.java +++ b/src/main/java/nl/andrewl/distribugit/cli/DistribuGitCommand.java @@ -27,10 +27,22 @@ public class DistribuGitCommand implements Callable { ) public String selectorExpression; - @CommandLine.Option(names = {"-a", "--action"}, description = "The command to run on each repository.", required = true) + @CommandLine.Option( + names = {"-a", "--action"}, + description = """ + The command to run on each repository. + Each command has access to the following environment variables: + - DISTRIBUGIT_INVOKE_DIR - The directory in which distribugit was invoked. + - DISTRIBUGIT_WORKING_DIR - The working directory of distribugit. + """, + required = true + ) public String actionCommand; - @CommandLine.Option(names = {"-fa", "--finalization-action"}, description = "A command to run on each repository after all normal actions.") + @CommandLine.Option( + names = {"-fa", "--finalization-action"}, + description = "A command to run on each repository after all normal actions. Has access to the same environment variables as --action." + ) public String finalizationActionCommand; @CommandLine.Option(names = {"-t", "--access-token"}, description = "The access token to use to perform operations.")