go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-01 13:07:49 +02:00
Code Issues Releases Activity

docs: improve several documentation pages

Browse Source 
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos Alexandro Becker 2021-09-22 23:30:16 -03:00
parent ac92cb658a
commit 55dd91e404
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
10 changed files with 46 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -318,6 +318,9 @@ To make your releases, checksums, and signatures reproducible, you will need to
## Import pre-built binaries
!!! success "GoReleaser Pro"
The prebuilt buidler is a [GoReleaser Pro feature](/pro/).
Since GoReleaser Pro v0.179.0, it is possible to import pre-built binaries into the GoReleaser lifecycle.
Reasons you might want to do that include:
@ -380,6 +383,3 @@ There is no difference in how the binaries are handled.
!!! warning
When using the `prebuilt` binary, there are no defaults for `goos` et al,
so you need to either provide those or the final `targets` matrix.
!!! info
The `prebuilt` builder is a [GoReleaser Pro feature](/pro/).

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

@ -239,6 +239,9 @@ docker build -t myuser/myimage . \
## Podman
!!! success "GoReleaser Pro"
The podman backend is a [GoReleaser Pro feature](/pro/).
You can use [`podman`](https://podman.io) instead of `docker` by setting `use` to `podman` on your config:
```yaml
@ -252,9 +255,6 @@ dockers:
Note that GoReleaser will not install Podman for you, nor change any of its configuration.
!!! info
The Podman backend is a [GoReleaser Pro feature](/pro/).
## Buildpacks
You can use [`buildpacks`](https://buildpacks.io) instead of `docker` by setting `use` to `buildpacks` on your config:

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

@ -142,6 +142,9 @@ and push everything to Docker Hub.
## Podman
!!! success "GoReleaser Pro"
The podman backend is a [GoReleaser Pro feature](/pro/).
You can use [`podman`](https://podman.io) instead of `docker` by setting `use` to `podman` on your config:
```yaml
@ -155,6 +158,3 @@ docker_manifests:
```
Note that GoReleaser will not install Podman for you, nor change any of its configuration.
!!! info
The Podman backend is a [GoReleaser Pro feature](/pro/).

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

@ -2,6 +2,10 @@
title: Fury.io
---
!!! success "GoReleaser Pro"
The fury.io publisher is a [GoReleaser Pro feature](/pro/).
You might be able to reproduce some of its behavior on GoReleaser OSS using [custom publishers](/customization/publishers/).
With [GoReleaser Pro](/pro) you can easily create deb and yum repositories on [fury.io][fury].
## Usage
@ -48,8 +52,4 @@ furies:
- deb
```
!!! info
The fury publisher is a [GoReleaser Pro feature](/pro/).
You might be able to reproduce some of its behavior on GoReleaser OSS using [custom publishers](/customization/publishers/).
[fury]: https://fury.io/

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

@ -29,6 +29,9 @@ You can also go crazy with `sh -c "my commands"`, but it gets ugly real fast.
## Pro Features
!!! success "GoReleaser Pro"
Global after hooks and the additional options in before hooks are [GoReleaser Pro features](/pro/).
With [GoReleaser Pro](/pro/), things are a bit more flexible: you can specify the dir, environment variables and also global after hooks.
```yaml
@ -58,8 +61,5 @@ after:
RELEASE_DONE: 'something-{{ .ProjectName }}' # specify hook level environment variables
```
!!! info
Global after hooks is a [GoReleaser Pro feature](/pro/).
!!! tip
Learn more about the [name template engine](/customization/templates/).

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

@ -1,5 +1,8 @@
# Includes
!!! success "GoReleaser Pro"
Includes is a [GoReleaser Pro feature](/pro/).
GoReleaser allows you to include other files from an URL or in the current filesystem.
Files are included recursively in the order they are declared.
@ -19,6 +22,3 @@ includes:
# header values are expanded in case they are environment variables
x-api-token: "${MYCOMPANY_TOKEN}"
```
!!! info
Includes is a [GoReleaser Pro feature](/pro/).

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

@ -2,6 +2,9 @@
title: Monorepo
---
!!! success "GoReleaser Pro"
The monorepo support is a [GoReleaser Pro feature](/pro/).
If you want to use GoReleaser within a monorepo and use tag prefixes to mark "which tags belong to which sub project", GoReleaser got you covered.
## Premise
@ -39,9 +42,6 @@ Then, the following is different from a "regular" run:
The rest of the release process should work as usual.
!!! info
Monorepo support is a [GoReleaser Pro feature](/pro/).
!!! warning
This feature is in beta and might change based on feedback.
Let me know you think about it after trying it out!

19
www/docs/customization/snapshots.md
View File

@ -22,15 +22,20 @@ snapshot:
## How it works
When you run GoReleaser with `--snapshot`, it will set the `Version` template
variable to the evaluation of `snapshot.name_template`.
When you run GoReleaser with `--snapshot`, it will set the `Version` template variable to the evaluation of `snapshot.name_template`.
This means that if you use `{{ .Version }}` on your name templates, you'll get the snapshot version.
This means that if you use `{{ .Version }}` on your name templates, you'll
get the snapshot version.
You can also check if its a snapshot build inside a template with:
```
{{ if .IsSnapshot }}something{{ else }}something else{{ end }}
```
!!! tip
Learn more about the [name template engine](/customization/templates/).
Note that the idea behind GoReleaser's snapshots if mostly for local builds
or to validate your build on the CI pipeline. Artifacts shouldn't be uploaded
anywhere, and will only be generated to the `dist` folder.
Note that the idea behind GoReleaser's snapshots is for local builds or to validate your build on the CI pipeline.
Artifacts wont't be uploaded and will only be generated into the `dist` folder.
!!! info "Maybe you are looking for something else?"
If just want to build the binaries, and no packages at all, check the [`goreleaser build` command](/cmd/goreleaser_build/);

9
www/docs/customization/templates.md
View File

@ -96,7 +96,10 @@ GOVERSION_NR=$(go version | awk '{print $3;}') goreleaser
## Custom variables
On [GoReleaser Pro](/pro/) you can also declare custom variables.
!!! success "GoReleaser Pro"
Custom template variables support is a [GoReleaser Pro feature](/pro/).
You can also declare custom variables.
This feature is specially useful with [includes](/customization/includes/), so you can have more generic config files.
Usage is as simple as you would expect:
@ -106,12 +109,10 @@ Usage is as simple as you would expect:
variables:
description: my project description
somethingElse: yada yada yada
empty: ""
```
And then you can use those fields as `{{ .description }}`, for example.
!!! warning
You won't be allowed to override GoReleaser "native" fields.
!!! info
Custom variables is a [GoReleaser Pro feature](/pro/).

14
www/docs/pro.md
View File

@ -1,6 +1,6 @@
# GoReleaser Pro
GoReleaser Pro is now available with some unique features such as:
GoReleaser Pro is a paid, closed-source GoReleaser distribution with some additional features:
- [x] Import pre-built binaries with the [`prebuilt` builder](/customization/build/#import-pre-built-binaries);
- [x] Rootless build [Docker images](/customization/docker/#podman) and [manifests](/customization/docker_manifest/#podman) with [Podman](https://podman.io);
@ -13,8 +13,6 @@ GoReleaser Pro is now available with some unique features such as:
<script src="https://gumroad.com/js/gumroad.js"></script>
<a class="gumroad-button" href="https://gumroad.com/l/CadfZ" target="_blank">Get GoReleaser Pro</a>
_or go to [https://gum.co/goreleaser](https://gum.co/goreleaser)_
## Roadmap
The roadmap is not public (yet), but we do have a couple of ideas and your input is always welcome!
@ -22,8 +20,8 @@ Once you buy it, feel free to [email me](mailto:carlos@becker.software?subject=G
## Pricing & Sponsors
- The current pricing is "low" and is likely to increase as we keep adding more pro-only features;
- If you sponsor either the project or its developers, you [can ask for a discount](mailto:carlos@becker.software?subject=GoReleaser%20Coupon%20Request)!
- The current pricing is low and is likely to increase as we keep adding more pro-only features;
- If you sponsor either the project or any of its developers, you [can ask for a discount](mailto:carlos@becker.software?subject=GoReleaser%20Coupon%20Request)!
## Enterprise support
@ -31,9 +29,11 @@ I don't have a plan for that yet, but please [email me](mailto:carlos@becker.sof
## Using GoReleaser Pro
When you buy it on [gumroad](https://gum.co/goreleaser), you'll get a license key.
Once you [buy it](https://gum.co/goreleaser), you'll get a license key.
You can then pass it to the [`release` command](/cmd/goreleaser_release/) either via the `--key` flag or the `GORELEASER_KEY` environment variable.
You can then pass it to the `release` command either via the `--key` flag or the `GORELEASER_KEY` environment variable.
If you use the GitHub action, you will want to set the `distribution` option to `goreleaser-pro`.
Check the [documentation](/ci/actions/) for more details.
---