go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-11-06 09:09:29 +02:00
Code Issues Releases Activity

docs: improve signing docs

Browse Source 
Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos A Becker
2021-11-21 21:01:08 -03:00
parent 12066dd8d9
commit d296507f3a
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
www/docs/customization/docker_sign.md
View File

@@ -81,11 +81,13 @@ docker_signs:
These environment variables might be available in the fields that are templateable:
- `${artifactName}`: the name of the artifact
- `${artifact}`: the path to the artifact that will be signed
- `${artifact}`: the path to the artifact that will be signed [^1]
- `${artifactID}`: the ID of the artifact that will be signed
- `${certificate}`: the certificate filename, if provided
- `${signature}`: the signature filename, if provided
- `${artifactName}`: the name of the artifact [^1]
[^1]: notice that the this might contain `/` characters, which depending on how you use it migth evaluate to actual paths within the filesystem. Use with care.
## Common usage example

6
www/docs/customization/sign.md
View File

@@ -89,7 +89,7 @@ signs:
# Note that this should be a name, not a path.
#
# Defaults to empty.
certificate: '{{ trimsuffix .Env.artifactName ".tar.gz" }}.pem'
certificate: '{{ trimsuffix .Env.artifact ".tar.gz" }}.pem'
# List of environment variables that will be passed to the signing command as well as the templates.
#
@@ -103,11 +103,13 @@ signs:
These environment variables might be available in the fields that are templateable:
- `${artifactName}`: the name of the artifact
- `${artifact}`: the path to the artifact that will be signed
- `${artifactID}`: the ID of the artifact that will be signed
- `${certificate}`: the certificate filename, if provided
- `${signature}`: the signature filename
- `${artifactName}`: the name of the artifact [^1]
[^1]: notice that the name won't have the `dist` prefix, so if you are using it to build filepaths, be sure to prefix them properly. Prefer using `${artifact}` instead.
## Signing with cosign