Skip to content

Commit 1f3106b

Browse files
committed
setup: Add tag controls to help
Signed-off-by: Adolfo García Veytia (Puerco) <puerco@carabiner.dev>
1 parent a84a232 commit 1f3106b

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

sourcetool/internal/cmd/setup.go

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,21 @@ func AddSetupRepo(parent *cobra.Command) {
8686
setupRepoCmd := &cobra.Command{
8787
Short: "configure all the SLSA source features in a repository",
8888
Long: `The setup repo subcommand is a "one shot" setup process enabling all
89-
the security controls required to get a repository to a specific SLSA level.
89+
the security controls required to get a repository to SLSA Source level 3.
9090
9191
This command is ideal for new repositories or when you are sure the implemented
9292
changes will not disrupt existing workflows.
9393
94-
To use this subcommand you need to export a GitHub token as an environment
94+
To run this command make sure sourcetool is authorized on the repository
95+
(try sourcetool auth whoami ) or export a GitHub token as an environment
9596
variable called GITHUB_TOKEN. The token needs admin permissions on the repo
9697
to configure the branch rules.
9798
99+
If the SLSA controls are already enforce in the repository they will be left
100+
untouched.
101+
102+
Alternatively, to enable each control individually use: sourcetool setup controls.
103+
98104
`,
99105
Use: "repo owner/repo",
100106
SilenceUsage: false,
@@ -229,8 +235,12 @@ as an identity source.
229235
The values for --config are as follows:
230236
231237
%s
232-
Configures push and delete protection in the repository, required to reach slsa
233-
source level 2+.
238+
Configures push and delete branch protection in the repository, required to reach
239+
SLSA source level 2+.
240+
241+
%s
242+
Configures udpate, push and delete protection for all tags in the repository,
243+
this is required to reach SLSA source level 2+.
234244
235245
%s
236246
Opens a pull request in the repository to add the provenance generation workflow
@@ -247,7 +257,8 @@ repositories. Make sure you have a fork of the SLSA source policy repo and
247257
a fork of the repository you want to protect.
248258
249259
`, w("sourcetool setup controls"), w2("configure a repository for SLSA source"),
250-
w2(models.CONFIG_BRANCH_RULES), w2(models.CONFIG_GEN_PROVENANCE), w2(models.CONFIG_POLICY)),
260+
w2(models.CONFIG_BRANCH_RULES), w2(models.CONFIG_TAG_RULES),
261+
w2(models.CONFIG_GEN_PROVENANCE), w2(models.CONFIG_POLICY)),
251262
Use: "controls owner/repo --config=CONTROL1 --config=CONTROL2",
252263
SilenceUsage: false,
253264
SilenceErrors: true,

0 commit comments

Comments
 (0)