1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-09-16 09:26:52 +02:00

docs: formatted all docs

Based on prettier/prettier
This commit is contained in:
Carlos Alexandro Becker
2017-12-10 15:17:29 -02:00
parent d7da2c295a
commit 5345aadd0d
14 changed files with 54 additions and 47 deletions

View File

@@ -13,10 +13,9 @@ For more information, see the `CONTRIBUTING` guide.
Please paste the output of:
- `go version`
- `uname -a`
- `goreleaser --debug`
* `go version`
* `uname -a`
* `goreleaser --debug`
### Steps to Reproduce
@@ -27,4 +26,3 @@ Please paste the output of:
**Expected behavior:** [What you expected to happen]
**Actual behavior:** [What actually happened]

View File

@@ -2,12 +2,11 @@
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] I have read the **CONTRIBUTING** document.
- [ ] `make ci` passes on my machine.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
* [ ] Bug fix (non-breaking change which fixes an issue)
* [ ] New feature (non-breaking change which adds functionality)
* [ ] Breaking change (fix or feature that would cause existing functionality to change)
* [ ] I have read the **CONTRIBUTING** document.
* [ ] `make ci` passes on my machine.
* [ ] My change requires a change to the documentation.
* [ ] I have updated the documentation accordingly.
* [ ] I have added tests to cover my changes.

View File

@@ -13,7 +13,6 @@ install:
- export PATH=/snap/bin:$PATH
- sudo snap install snapcraft --candidate --classic
script:
- find . -name '*.md' | grep -v vendor | xargs prettier -l || { echo files above are not formatted with prettier/prettier; exit 1; }
- make ci
- test -n "$TRAVIS_TAG" || go run main.go --skip-validate --skip-publish
after_success:

View File

@@ -23,7 +23,7 @@ include:
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic

View File

@@ -3,7 +3,6 @@
By participating to this project, you agree to abide our [code of
conduct](/CODE_OF_CONDUCT.md).
## Setup your machine
`goreleaser` is written in [Go](https://golang.org/).
@@ -38,7 +37,6 @@ A good way of making sure everything is all right is running the test suite:
$ make test
```
## Test your change
You can create a branch for your changes and try to build from the source as you go:
@@ -55,7 +53,6 @@ $ make ci
Which runs all the linters and tests.
## Create a commit
Commit messages should be well formatted.
@@ -80,7 +77,6 @@ help others to generate their own changelog.
See #284
```
## Submit a pull request
Push your branch to your `goreleaser` fork and open a pull request against the

View File

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.

View File

@@ -26,11 +26,13 @@ cover: test
# gofmt and goimports all go files
fmt:
find . -name '*.go' -not -wholename './vendor/*' | while read -r file; do gofmt -w -s "$$file"; goimports -w "$$file"; done
find . -name '*.md' -not -wholename './vendor/*' | xargs prettier --write
.PHONY: fmt
# Run all the linters
lint:
gometalinter --vendor ./...
find . -name '*.md' -not -wholename './vendor/*' | xargs prettier -l
.PHONY: lint
# Run all the tests and code checks

View File

@@ -33,7 +33,6 @@ at https://goreleaser.com
[![goreleaser/goreleaser stargazers over time](https://starcharts.herokuapp.com/goreleaser/goreleaser.svg)](https://starcharts.herokuapp.com/goreleaser/goreleaser)
---
Would you like to fix something in the documentation? Feel free to open an [issue](https://github.com/goreleaser/goreleaser/issues).

View File

@@ -19,8 +19,23 @@ that and rewrote the whole thing in Go.
## Installing Goreleaser
There are three ways to get going.
There are three ways to get going install GoReleaser:
1. Install Goreleaser via go get (`goreleaser` command will be globally available) `go get github.com/goreleaser/goreleaser`
1. On a Mac use [Homebrew](https://github.com/goreleaser/homebrew-tap).
1. Install directly [from the binaries](https://github.com/goreleaser/goreleaser/releases/latest).
### Using go get
```sh
go get github.com/goreleaser/goreleaser
```
### Using homebrew
```sh
brew install goreleaser/tap/goreleaser
```
> [tap source](https://github.com/goreleaser/homebrew-tap)
## Manually
Download your preferred flavor from the [releases page](https://github.com/goreleaser/goreleaser/releases/latest) and install
manually.

View File

@@ -70,9 +70,9 @@ This configuration will generate `tar` archives, each containing an additional
file called `drum-roll.licence.txt`.
The archives will be located in the `dist` folder:
- `./dist/drum-roll_windows_64-bit.tar.gz`
- `./dist/drum-roll_macOS_64-bit.tar.gz`
- `./dist/drum-roll_Tux_64-bit.tar.gz`
* `./dist/drum-roll_windows_64-bit.tar.gz`
* `./dist/drum-roll_macOS_64-bit.tar.gz`
* `./dist/drum-roll_Tux_64-bit.tar.gz`
Next, you need to export a `GITHUB_TOKEN` environment variable, which should contain a
GitHub token with the `repo` scope selected.

View File

@@ -17,7 +17,6 @@ Here is how to do it with Travis CI:
By default, GoReleaser will create its artifacts in the `./dist` folder.
If you must, you can change it by setting it in the `.goreleaser.yml` file:
```yaml
# .goreleaser.yml
dist: another-folder-that-is-not-dist
@@ -25,7 +24,7 @@ dist: another-folder-that-is-not-dist
## Using the `main.version`
GoReleaser always sets a `main.version` *ldflag*.
GoReleaser always sets a `main.version` _ldflag_.
You can use it in your `main.go` file:
```go

View File

@@ -2,7 +2,7 @@
title: Homebrew
---
After releasing to GitHub, GoReleaser can generate and publish a *homebrew-tap*
After releasing to GitHub, GoReleaser can generate and publish a _homebrew-tap_
recipe into a repository that you have access to.
The `brew` section specifies how the formula should be created.

View File

@@ -7,7 +7,7 @@ GoReleaser supports building and pushing artifacts into Artifactory.
## How it works
You can declare multiple Artifactory instances.
You can declare multiple Artifactory instances.
All binaries generated by your `builds` section will be pushed to
each configured Artifactory.
@@ -24,8 +24,8 @@ artifactories:
Prerequisites:
- A running Artifactory instances
- A user + password / API key with grants to upload an artifact
* A running Artifactory instances
* A user + password / API key with grants to upload an artifact
### Target
@@ -45,14 +45,14 @@ http://artifacts.company.com:8081/artifactory/example-repo-local/goreleaser/1.0.
Support variables:
- Version
- Tag
- ProjectName
- Os
- Arch
- Arm
* Version
* Tag
* ProjectName
* Os
* Arch
* Arm
*Attention*: Variables _Os_, _Arch_ and _Arm_ are only supported in upload mode `binary`.
_Attention_: Variables _Os_, _Arch_ and _Arm_ are only supported in upload mode `binary`.
### Password / API Key

View File

@@ -2,11 +2,11 @@
title: Links
---
- Follow the progress on the [GitHub repository](https://github.com/goreleaser/goreleaser)
- Follow [@caarlos0](https://twitter.com/caarlos0) on Twitter for updates
- [Slack](https://gophers.slack.com/messages/goreleaser/) to chat about GoReleaser,
questions, etc. Join using [this link](https://invite.slack.golangbridge.org/)
- [Contributing Guidelines](https://github.com/goreleaser/goreleaser/blob/master/CONTRIBUTING.md)
* Follow the progress on the [GitHub repository](https://github.com/goreleaser/goreleaser)
* Follow [@caarlos0](https://twitter.com/caarlos0) on Twitter for updates
* [Slack](https://gophers.slack.com/messages/goreleaser/) to chat about GoReleaser,
questions, etc. Join using [this link](https://invite.slack.golangbridge.org/)
* [Contributing Guidelines](https://github.com/goreleaser/goreleaser/blob/master/CONTRIBUTING.md)
This project adheres to the Contributor Covenant
[code of conduct](https://github.com/goreleaser/goreleaser/blob/master/CODE_OF_CONDUCT.md).