Merge pull request #1364 from imjasonh/text-check

fix wolfictl text check

.github/workflows/build.yaml

@@ -58,11 +58,17 @@ jobs:
         with:
           repository: 'wolfi-dev/os'
           path: 'wolfi-os'
+
+      # This command is not itself used by Wolfi directly, but it demonstrates that we're able to construct a graph of packages
+      # without cycles or unsatisfied deps, which prevents a class of build failures.
+      # This check is here to ensure that graph construction changes in this repo don't break graph resolution on the Wolfi OS repo.
       - name: Test Wolfi OS repo
         run: |
           ./wolfictl text -d wolfi-os \
             --type=name \
             --pipeline-dir=wolfi-os/pipelines/ \
+            --repository-append=https://packages.wolfi.dev/os \
+            --keyring-append=https://packages.wolfi.dev/os/wolfi-signing.rsa.pub \
             --keyring-append=https://packages.wolfi.dev/bootstrap/stage3/wolfi-signing.rsa.pub \
             --repository-append=https://packages.wolfi.dev/bootstrap/stage3
 

docs/cmd/wolfictl.md

@@ -25,7 +25,6 @@ A CLI helper for developing Wolfi
 * [wolfictl lint](wolfictl_lint.md)	 - Lint the code
 * [wolfictl ruby](wolfictl_ruby.md)	 - Work with ruby packages
 * [wolfictl scan](wolfictl_scan.md)	 - Scan a package for vulnerabilities
-* [wolfictl text](wolfictl_text.md)	 - Print a sorted list of downstream dependent packages
 * [wolfictl version](wolfictl_version.md)	 - Prints the version
 * [wolfictl withdraw](wolfictl_withdraw.md)	 - Withdraw packages from an APKINDEX.tar.gz
 

docs/man/man1/wolfictl.1

@@ -30,4 +30,4 @@ A CLI helper for developing Wolfi
 
 .SH SEE ALSO
 .PP
-\fBwolfictl\-advisory(1)\fP, \fBwolfictl\-apk(1)\fP, \fBwolfictl\-bump(1)\fP, \fBwolfictl\-check(1)\fP, \fBwolfictl\-dot(1)\fP, \fBwolfictl\-gh(1)\fP, \fBwolfictl\-image(1)\fP, \fBwolfictl\-lint(1)\fP, \fBwolfictl\-ruby(1)\fP, \fBwolfictl\-scan(1)\fP, \fBwolfictl\-text(1)\fP, \fBwolfictl\-version(1)\fP, \fBwolfictl\-withdraw(1)\fP
+\fBwolfictl\-advisory(1)\fP, \fBwolfictl\-apk(1)\fP, \fBwolfictl\-bump(1)\fP, \fBwolfictl\-check(1)\fP, \fBwolfictl\-dot(1)\fP, \fBwolfictl\-gh(1)\fP, \fBwolfictl\-image(1)\fP, \fBwolfictl\-lint(1)\fP, \fBwolfictl\-ruby(1)\fP, \fBwolfictl\-scan(1)\fP, \fBwolfictl\-version(1)\fP, \fBwolfictl\-withdraw(1)\fP

pkg/cli/text.go

@@ -18,7 +18,13 @@ func cmdText() *cobra.Command {
 	text := &cobra.Command{
 		Use:   "text",
 		Short: "Print a sorted list of downstream dependent packages",
-		Args:  cobra.NoArgs,
+		Long: `This command prints a list of packages, sorted in the order they would need to be built.
+
+If this command is successful, it means there is a solveable dependency graph and the packages can be built in the order they are printed.
+
+If this fails, there may be an unsatisfiable dependency or a cycle in the graph.`,
+		Args:   cobra.NoArgs,
+		Hidden: true,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			ctx := cmd.Context()
 			if pipelineDir == "" {