From 532bf4e0a36bed0daa1d76b396cfd1076ad13ebf Mon Sep 17 00:00:00 2001 From: Carlos Alexandro Becker Date: Mon, 28 May 2018 10:49:38 -0300 Subject: [PATCH] docs: prettier changed lists from * to - Thanks obama --- .github/ISSUE_TEMPLATE/Bug_report.md | 10 +++++----- .github/ISSUE_TEMPLATE/Feature_request.md | 4 ++-- CODE_OF_CONDUCT.md | 20 ++++++++++---------- CONTRIBUTING.md | 10 +++++----- config/config_array_test.go | 10 +++++----- pipeline/s3/s3_test.go | 6 +++--- www/content/artifactory.md | 16 ++++++++-------- www/content/docker.md | 8 ++++---- www/content/environment.md | 6 +++--- www/content/links.md | 8 ++++---- www/content/quick-start.md | 6 +++--- www/content/release.md | 2 +- 12 files changed, 53 insertions(+), 53 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 846de9e35..12495e54e 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,6 +1,6 @@ ---- +--- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve --- **Describe the bug** @@ -21,9 +21,9 @@ A clear and concise description of what you expected to happen. **Environment (please complete the following information):** -* OS: [e.g. mac, linux] -* OS version: [uname -a] -* GoReleaser Version [goreleaser --version] +- OS: [e.g. mac, linux] +- OS version: [uname -a] +- GoReleaser Version [goreleaser --version] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 653f06e8f..e61f9114d 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,6 +1,6 @@ ---- +--- name: Feature request -about: Suggest an idea for this project +about: Suggest an idea for this project --- **Is your feature request related to a problem? Please describe.** diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index fcf20b2cb..e9f6fc563 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -14,21 +14,21 @@ orientation. Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or +- The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 316f67428..564927adf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,11 +9,11 @@ conduct](/CODE_OF_CONDUCT.md). Prerequisites: -* `make` -* [Go 1.10+](https://golang.org/doc/install) -* `rpmbuild` (`apt get install rpm`/`brew install rpm`) -* [snapcraft](https://snapcraft.io/) -* [Docker](https://www.docker.com/) +- `make` +- [Go 1.10+](https://golang.org/doc/install) +- `rpmbuild` (`apt get install rpm`/`brew install rpm`) +- [snapcraft](https://snapcraft.io/) +- [Docker](https://www.docker.com/) Clone `goreleaser` from source into `$GOPATH`: diff --git a/config/config_array_test.go b/config/config_array_test.go index 19417dcda..759964769 100644 --- a/config/config_array_test.go +++ b/config/config_array_test.go @@ -101,14 +101,14 @@ func TestStringArray(t *testing.T) { } // func TestStringArrayFailure(t *testing.T) { - // var source = ` +// var source = ` // strings: - // key: val +// key: val // ` - // var actual Unmarshaled - // err := yaml.UnmarshalStrict([]byte(source), &actual) - // // assert.EqualError(t, err, ) +// var actual Unmarshaled +// err := yaml.UnmarshalStrict([]byte(source), &actual) +// // assert.EqualError(t, err, ) // } func TestFlagArray(t *testing.T) { diff --git a/pipeline/s3/s3_test.go b/pipeline/s3/s3_test.go index 8f57f004b..0d643370c 100644 --- a/pipeline/s3/s3_test.go +++ b/pipeline/s3/s3_test.go @@ -28,11 +28,11 @@ func TestDefaultsNoS3(t *testing.T) { var assert = assert.New(t) var ctx = context.New(config.Project{ S3: []config.S3{ - config.S3{}, + {}, }, }) assert.NoError(Pipe{}.Default(ctx)) - assert.Equal([]config.S3{config.S3{}}, ctx.Config.S3) + assert.Equal([]config.S3{{}}, ctx.Config.S3) } func TestDefaults(t *testing.T) { @@ -45,7 +45,7 @@ func TestDefaults(t *testing.T) { }, }) assert.NoError(Pipe{}.Default(ctx)) - assert.Equal([]config.S3{config.S3{ + assert.Equal([]config.S3{{ Bucket: "foo", Region: "us-east-1", Folder: "{{ .ProjectName }}/{{ .Tag }}", diff --git a/www/content/artifactory.md b/www/content/artifactory.md index b9d52bd7b..9a3c05609 100644 --- a/www/content/artifactory.md +++ b/www/content/artifactory.md @@ -27,8 +27,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,12 +45,12 @@ and will result in a final deployment like `http://artifacts.company.com:8081/ar Supported 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`. diff --git a/www/content/docker.md b/www/content/docker.md index 873ac1a64..9213bfbfd 100644 --- a/www/content/docker.md +++ b/www/content/docker.md @@ -117,10 +117,10 @@ dockers: This will build and publish the following images: -* myuser/myimage:v1.6.4 -* myuser/myimage:v1 -* myuser/myimage:v1.6 -* myuser/myimage:latest +- myuser/myimage:v1.6.4 +- myuser/myimage:v1 +- myuser/myimage:v1.6 +- myuser/myimage:latest With these settings you can hopefully push several different docker images with multiple tags. diff --git a/www/content/environment.md b/www/content/environment.md index 0b356df0e..7f2b5bf77 100644 --- a/www/content/environment.md +++ b/www/content/environment.md @@ -58,10 +58,10 @@ dist: another-folder-that-is-not-dist Default wise GoReleaser sets three _ldflags_: -* `main.version`: Current Git tag (the `v` prefix is stripped) or the name of +- `main.version`: Current Git tag (the `v` prefix is stripped) or the name of the snapshot, if you're using the `--snapshot` flag -* `main.commit`: Current git commit SHA -* `main.date`: Date according [RFC3339](https://golang.org/pkg/time/#pkg-constants) +- `main.commit`: Current git commit SHA +- `main.date`: Date according [RFC3339](https://golang.org/pkg/time/#pkg-constants) You can use it in your `main.go` file: diff --git a/www/content/links.md b/www/content/links.md index 80a43301b..e9df73a8c 100644 --- a/www/content/links.md +++ b/www/content/links.md @@ -4,11 +4,11 @@ menu: true weight: 999 --- -* Follow the progress on the [GitHub repository](https://github.com/goreleaser/goreleaser) -* Follow [@goreleaser](https://twitter.com/goreleaser) on Twitter for updates -* Chat on [Slack](https://gophers.slack.com/messages/goreleaser/) to chat about GoReleaser, +- Follow the progress on the [GitHub repository](https://github.com/goreleaser/goreleaser) +- Follow [@goreleaser](https://twitter.com/goreleaser) on Twitter for updates +- Chat on [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) +- [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). diff --git a/www/content/quick-start.md b/www/content/quick-start.md index a557f54bc..9c3b1ca32 100644 --- a/www/content/quick-start.md +++ b/www/content/quick-start.md @@ -72,9 +72,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. diff --git a/www/content/release.md b/www/content/release.md index 972584c6e..32ff53111 100644 --- a/www/content/release.md +++ b/www/content/release.md @@ -85,4 +85,4 @@ $ goreleaser --release-notes <(some_changelog_generator) Some changelog generators you can use: -* [buchanae/github-release-notes](https://github.com/buchanae/github-release-notes) +- [buchanae/github-release-notes](https://github.com/buchanae/github-release-notes)