Skip to content

Commit

Permalink
fix: clarify usge
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Kotzbauer <[email protected]>
  • Loading branch information
ckotzbauer committed Dec 4, 2022
1 parent 2d7d94e commit 68148a3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,14 @@ The `autoCreate` option of DT is used. You have to set the `--format` flag to `c
| `git-password` | `false` | `""` | Git-Password |
| `github-app-id` | `false` | `""` | GitHub App-ID. |
| `github-app-installation-id` | `false` | `""` | GitHub App-Installation-ID. |
| `git-fallback-clone` | `false` | `false` | Use git binary for clones. |
| `git-fallback-clone` | `false` | `false` | **Deprecated:**: Use git binary for clones. |

The operator will save all files with a specific folder structure as described below. When a `git-path` is configured, all folders above this path are not touched
from the application. Assuming that `git-path` is set to `dev-cluster/sboms`. When no `git-path` is given, the structure below is directly in the repository-root.
The structure is basically `<git-path>/<registry-server>/<image-path>/<image-digest>/sbom.json` (see example below).
The file-extension may differ when another output-format is configured.
You can use a token-based authentication (e.g. a PAT for GitHub) with `--git-access-token`, BasicAuth with username and password (`--git-username`, `--git-password`) or
Github App Authentication (`--github-app-id`, `--github-app-installation-id`, env: `SBOM_GITHUB_APP_PRIVATE_KEY`) The private-key has to be Base64 encoded.
To clone repositories with a git-binary instead of the pure golang implementation, add the `--git-fallback-clone` flag. This is needed for Git-Providers which
need `multi_ack` e.g. Azure DevOps or AWS CodeCommit.
See [this issue](https://github.com/go-git/go-git/issues/64) for more details.

**Note**: It is required, that the specified branch of the repo is fully initialized. There's no logic which creates a non-existent branch. Just commit a `README.md`
Expand Down
6 changes: 5 additions & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,11 @@ func newRootCmd() *cobra.Command {
rootCmd.PersistentFlags().String(internal.ConfigKeyOciUser, "", "OCI-User")
rootCmd.PersistentFlags().String(internal.ConfigKeyOciToken, "", "OCI-Token")

rootCmd.PersistentFlags().MarkDeprecated(internal.ConfigKeyGitFallbackClone, "'multi_ack' is supported by default. The flag doesn't have any effect and will be removed in 0.25.0")
err := rootCmd.PersistentFlags().MarkDeprecated(internal.ConfigKeyGitFallbackClone, "'multi_ack' is supported by default. The flag doesn't have any effect and will be removed in 0.24.0")
if err != nil {
panic(err)
}

return rootCmd
}

Expand Down

0 comments on commit 68148a3

Please sign in to comment.