Skip to content

Commit

Permalink
Run make generate
Browse files Browse the repository at this point in the history
  • Loading branch information
BrianMMcClain committed Jan 21, 2025
1 parent 3cb5ad3 commit 4a0217f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 21 deletions.
Original file line number Diff line number Diff line change
@@ -1,23 +1,14 @@
<!-- Code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; DO NOT EDIT MANUALLY -->

- `destination` (string) - Destination is an optional field that specifies the path where the SBOM
file will be downloaded to for the user.
The 'Destination' must be a writable location. If the destination is a file,
the SBOM will be saved or overwritten at that path. If the destination is
a directory, a file will be created within the directory to store the SBOM.
Any parent directories for the destination must already exist and be
writable by the provisioning user (generally not root), otherwise,
a "Permission Denied" error will occur. If the source path is a file,
it is recommended that the destination path be a file as well.
- `destination` (string) - The path on the local machine to store a copy of the SBOM file.
You can specify an absolute or a path relative to the working directory
when you execute the Packer build. If the file already exists on the
local machine, Packer overwrites the file. If the destination is a
directory, the directory must already exist.

- `sbom_name` (string) - The name to give the SBOM when uploaded on HCP Packer

By default this will be generated, but if you prefer to have a name
of your choosing, you can enter it here.
The name must match the following regexp: `[a-zA-Z0-9_-]{3,36}`

Note: it must be unique for a single build, otherwise the build will
fail when uploading the SBOMs to HCP Packer, and so will the Packer
build command.
- `sbom_name` (string) - The name of the SBOM file stored in HCP Packer.
If omitted, HCP Packer uses the build fingerprint as the file name.
This value must be between three and 36 characters from the following set: `[A-Za-z0-9_-]`.
You must specify a unique name for each build in an artifact version.

<!-- End of code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; -->
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<!-- Code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; DO NOT EDIT MANUALLY -->

- `source` (string) - Source is a required field that specifies the path to the SBOM file that
needs to be downloaded.
It can be a file path or a URL.
- `source` (string) - The file path or URL to the SBOM file in the Packer artifact.
This file must either be in the SPDX or CycloneDX format.

<!-- End of code generated from the comments of the Config struct in provisioner/hcp-sbom/provisioner.go; -->

0 comments on commit 4a0217f

Please sign in to comment.