From 75b38763dcc06de72e17b0a64d3019a5e76f47bf Mon Sep 17 00:00:00 2001 From: Jake Coffman Date: Thu, 21 Dec 2023 13:17:42 -0600 Subject: [PATCH] add some docs --- tests/dependabot_test.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tests/dependabot_test.go b/tests/dependabot_test.go index 856eb18..1c35b96 100644 --- a/tests/dependabot_test.go +++ b/tests/dependabot_test.go @@ -22,6 +22,12 @@ func TestDependabot(t *testing.T) { scripttest.Test(t, ctx, engine, env, "../testdata/scripts/*.txt") } +// Commands returns the commands that can be used in the scripts. +// Each line of the scripts are +// So if you enter "dependabot update go_modules rsc/quote", it will run +// the Dependabot() function with args "update go_modules rsc/quote". +// When you use "echo" in the scripts it's actually running the echo command +// from the scripttest package. func Commands() map[string]script.Cmd { commands := scripttest.DefaultCmds() @@ -31,6 +37,7 @@ func Commands() map[string]script.Cmd { return commands } +// Dependabot runs the Dependabot CLI. TODO Should this build once then execute thereafter? func Dependabot() script.Cmd { return script.Command( script.CmdUsage{