diff --git a/docs/000-introduction.md b/docs/000-introduction.md index f9e9c47fa..fbd97c286 100644 --- a/docs/000-introduction.md +++ b/docs/000-introduction.md @@ -2,10 +2,14 @@ title: Introduction --- -GoReleaser is a release automation tool for Golang projects, the goal is to simplify the build, release and publish steps while providing variant customization options for all steps. +[GoReleaser](https://github.com/goreleaser/goreleaser) is a release automation +tool for Golang projects, the goal is to simplify the build, release and +publish steps while providing variant customization options for all steps. -GoReleaser is built for CI tools; you only need to [download and execute it](#integration-with-ci) in your build script. -You can [customize](#release-customization) your release process by createing a `.goreleaser.yml` file. +GoReleaser is built for CI tools; you only need to +[download and execute it](#ci_integration) in your build script. +You can [customize](#customization) your release process by +creating a `.goreleaser.yml` file. The idea started with a [simple shell script](https://github.com/goreleaser/old-go-releaser), diff --git a/docs/100-fpm.md b/docs/100-fpm.md index 5df9f32d9..a501deac5 100644 --- a/docs/100-fpm.md +++ b/docs/100-fpm.md @@ -2,7 +2,8 @@ title: Custom linux packages --- -GoReleaser can be wired to [fpm](https://github.com/jordansissel/fpm) to generate `.deb`, `.rpm` and other archives. Check its +GoReleaser can be wired to [fpm](https://github.com/jordansissel/fpm) to +generate `.deb`, `.rpm` and other archives. Check its [wiki](https://github.com/jordansissel/fpm/wiki) for more info. ```yml diff --git a/docs/110-snapcraft.md b/docs/110-snapcraft.md index 31bf60f3c..c7dc0e1f6 100644 --- a/docs/110-snapcraft.md +++ b/docs/110-snapcraft.md @@ -2,7 +2,11 @@ title: Snapcraft --- -GoReleaser can generate `snap` packages. [Snaps](http://snapcraft.io/) are a new packaging format that will let you publish your project directly to the Ubuntu store. From there it will be installable in all the [supported Linux distros](https://snapcraft.io/docs/core/install), with automatic and transactional updates. +GoReleaser can generate `snap` packages. [Snaps](http://snapcraft.io/) are a +new packaging format that will let you publish your project directly to the +Ubuntu store. From there it will be installable in all the +[supported Linux distros](https://snapcraft.io/docs/core/install), with +automatic and transactional updates. You can read more about it in the [snapcraft docs](https://snapcraft.io/docs/). @@ -60,4 +64,5 @@ snapcraft: daemon: simple ``` -Note that GoReleaser will not install `snapcraft` nor any of its dependencies for you. +Note that GoReleaser will not install `snapcraft` nor any of its dependencies +for you. diff --git a/docs/140-ci.md b/docs/140-ci.md index 030c31669..b6a8af842 100644 --- a/docs/140-ci.md +++ b/docs/140-ci.md @@ -2,7 +2,8 @@ title: CI integration --- -You may want to wire this to auto-deploy your new tags on [Travis](https://travis-ci.org), for example: +You may want to wire this to auto-deploy your new tags on +[Travis](https://travis-ci.org), for example: ```yaml # .travis.yml @@ -22,4 +23,5 @@ deployment: - curl -sL https://git.io/goreleaser | bash ``` -*Note that if you test multiple versions or multiple OSes you probably want to make sure GoReleaser is just run once* +**Note**: If you test multiple versions or multiple OSes you probably want to +make sure GoReleaser is just run once.