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

improving docs

Browse Source
This commit is contained in:
Carlos Alexandro Becker 2017-05-01 11:15:34 -03:00
parent f71a2daf31
commit e2f0f645cc
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -59,9 +59,6 @@ func main() {
By default GoReleaser will build the your current directory, but you can change the build package path in the GoReleaser configuration file.
To generate a `goreleaser.yml` file with the defaults, you can run `goreleaser init`.
You can then custumize the sections as you wish.
```yml
# goreleaser.yml
# Build customization
@ -169,11 +166,15 @@ func main() {
}
```
`version` will be the current Git tag or the name of the snapshot if you're using the `--snapshot` flag.
`version` will be the current Git tag (with `v` prefix stripped) or the name of the snapshot if you're using the `--snapshot` flag.
## Release customization
## GoReleaser customization
GoReleaser provides multiple customizations. We will cover them with the help of `goreleaser.yml`:
GoReleaser provides multiple customizations via the `goreleaser.yml` file.
You can generate it by running `goreleaser init` or start from scratch. The
defaults are sensible and fit for most projects.
We'll cover all customizations available bellow:
### Build customization
@ -431,6 +432,11 @@ fpm:
Note that GoReleaser will not install `fpm` nor any of its dependencies for you.
### Custom release notes
You can have a markdown file previously created with the release notes, and
pass it down to goreleaser with the `--release-notes=FILE` flag.
## Integration with CI
You may want to wire this to auto-deploy your new tags on [Travis](https://travis-ci.org), for example: