diff --git a/www/docs/customization/binary_sign.md b/www/docs/customization/binary_sign.md index 50183e7c9..4f334ef9e 100644 --- a/www/docs/customization/binary_sign.md +++ b/www/docs/customization/binary_sign.md @@ -113,6 +113,15 @@ templates: - `${certificate}`: the certificate filename, if provided - `${signature}`: the signature filename +### Differences from the default `signs` + +The only difference is the artifact filtering and that this pipe also runs in +the build phase. + +In `signs`, if you set `artifacts` to `binary`, it'll only work if you also set +`archives` `format` to `binary`. +Here, it'll work anyway. + ## Signing with cosign You can sign your artifacts with [cosign][] as well. diff --git a/www/docs/customization/sign.md b/www/docs/customization/sign.md index 5f800c6c0..a644a5066 100644 --- a/www/docs/customization/sign.md +++ b/www/docs/customization/sign.md @@ -1,4 +1,4 @@ -# Signing checksums and artifacts +# Signing archives, packages, checksums Signing ensures that the artifacts have been generated by yourself, and your users can verify that by comparing the generated signature with your public @@ -64,8 +64,8 @@ signs: # - installer: Windows MSI installers (Pro only) # - diskimage: macOS DMG disk images (Pro only) # - archive: archives from archive pipe - # - binary: binaries output from the build stage # - sbom: any SBOMs generated for other artifacts + # - binary: binaries (only when `archives.format` is 'binary', use binaries_sign otherwise) # # Default: 'none'. artifacts: all diff --git a/www/mkdocs.yml b/www/mkdocs.yml index f30549508..dcf45d5b2 100644 --- a/www/mkdocs.yml +++ b/www/mkdocs.yml @@ -115,7 +115,7 @@ nav: - customization/universalbinaries.md - customization/upx.md - customization/partial.md - - Packaging and Archiving: + - Package & Archive: - customization/archive.md - customization/nfpm.md - customization/dmg.md @@ -129,9 +129,9 @@ nav: - customization/sbom.md - customization/reportsizes.md - customization/metadata.md - - Signing & Notarizing: - - Checksums and artifacts: customization/sign.md + - Sign & Notarize: - Binaries: customization/binary_sign.md + - Archives, installers, packages, and checksums: customization/sign.md - Docker Images and Manifests: customization/docker_sign.md - customization/notarize.md - Publish: