From 4e0ba618d34a198fa30904b1bf8549010513a931 Mon Sep 17 00:00:00 2001 From: Ryan Date: Thu, 16 Dec 2021 06:11:56 +0100 Subject: [PATCH] fix: clarify --reuse and --rm flags (#929) * fix: clarify --reuse and --rm flags Signed-off-by: hackercat * lint(editorconfig): ignore *.md due to mixed style Signed-off-by: hackercat --- .editorconfig | 2 +- README.md | 4 ++-- cmd/root.go | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.editorconfig b/.editorconfig index 4c95ea48..c60bde86 100644 --- a/.editorconfig +++ b/.editorconfig @@ -12,7 +12,7 @@ indent_size = 4 indent_style = space indent_size = 2 -[Dockerfile] +[{Dockerfile,*.md}] indent_style = unset indent_size = unset diff --git a/README.md b/README.md index 7da2ac98..edec723f 100644 --- a/README.md +++ b/README.md @@ -191,8 +191,8 @@ It will save that information to `~/.actrc`, please refer to [Configuration](#co -p, --pull pull docker image(s) even if already present -q, --quiet disable logging of output from steps --rebuild rebuild local action docker image(s) even if already present - -r, --reuse reuse action containers to maintain state - --rm automatically remove containers just before exit + -r, --reuse don't remove container(s) on successfully completed workflow(s) to maintain state between runs + --rm automatically remove container(s)/volume(s) after a workflow(s) failure -s, --secret stringArray secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret) --secret-file string file with list of secrets to read from (e.g. --secret-file .secrets) (default ".secrets") --use-gitignore Controls whether paths specified in .gitignore should be copied into container (default true) diff --git a/cmd/root.go b/cmd/root.go index adfe69bf..9dfaff4b 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -42,7 +42,7 @@ func Execute(ctx context.Context, version string) { rootCmd.Flags().StringArrayVarP(&input.secrets, "secret", "s", []string{}, "secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret)") rootCmd.Flags().StringArrayVarP(&input.envs, "env", "", []string{}, "env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv)") rootCmd.Flags().StringArrayVarP(&input.platforms, "platform", "P", []string{}, "custom image to use per platform (e.g. -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04)") - rootCmd.Flags().BoolVarP(&input.reuseContainers, "reuse", "r", false, "reuse action containers to maintain state") + rootCmd.Flags().BoolVarP(&input.reuseContainers, "reuse", "r", false, "don't remove container(s) on successfully completed workflow(s) to maintain state between runs") rootCmd.Flags().BoolVarP(&input.bindWorkdir, "bind", "b", false, "bind working directory to container, rather than copy") rootCmd.Flags().BoolVarP(&input.forcePull, "pull", "p", false, "pull docker image(s) even if already present") rootCmd.Flags().BoolVarP(&input.forceRebuild, "rebuild", "", false, "rebuild local action docker image(s) even if already present") @@ -54,7 +54,7 @@ func Execute(ctx context.Context, version string) { rootCmd.Flags().BoolVar(&input.useGitIgnore, "use-gitignore", true, "Controls whether paths specified in .gitignore should be copied into container") rootCmd.Flags().StringArrayVarP(&input.containerCapAdd, "container-cap-add", "", []string{}, "kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE)") rootCmd.Flags().StringArrayVarP(&input.containerCapDrop, "container-cap-drop", "", []string{}, "kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE)") - rootCmd.Flags().BoolVar(&input.autoRemove, "rm", false, "automatically remove containers just before exit") + rootCmd.Flags().BoolVar(&input.autoRemove, "rm", false, "automatically remove container(s)/volume(s) after a workflow(s) failure") rootCmd.PersistentFlags().StringVarP(&input.actor, "actor", "a", "nektos/act", "user that triggered the event") rootCmd.PersistentFlags().StringVarP(&input.workflowsPath, "workflows", "W", "./.github/workflows/", "path to workflow file(s)") rootCmd.PersistentFlags().BoolVarP(&input.noWorkflowRecurse, "no-recurse", "", false, "Flag to disable running workflows from subdirectories of specified path in '--workflows'/'-W' flag")