docs: improve args examples

This commit is contained in:
Fernandez Ludovic 2023-06-11 17:25:06 +02:00
parent 825a50d3a2
commit 5be60c708e

View File

@ -23,16 +23,16 @@ Add `.github/workflows/golangci-lint.yml` with the following contents:
name: golangci-lint name: golangci-lint
on: on:
push: push:
tags:
- v*
branches: branches:
- master - master
- main - main
pull_request: pull_request:
permissions: permissions:
contents: read contents: read
# Optional: allow read access to pull request. Use with `only-new-issues` option. # Optional: allow read access to pull request. Use with `only-new-issues` option.
# pull-requests: read # pull-requests: read
jobs: jobs:
golangci: golangci:
name: lint name: lint
@ -56,7 +56,7 @@ jobs:
# #
# Note: by default the `.golangci.yml` file should be at the root of the repository. # Note: by default the `.golangci.yml` file should be at the root of the repository.
# The location of the configuration file can be changed by using `--config=` # The location of the configuration file can be changed by using `--config=`
# args: --config=/my/path/.golangci.yml --issues-exit-code=0 # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
# Optional: show only new issues if it's a pull request. The default value is `false`. # Optional: show only new issues if it's a pull request. The default value is `false`.
# only-new-issues: true # only-new-issues: true
@ -83,8 +83,6 @@ If you need to run linters for specific operating systems, you will need to use
name: golangci-lint name: golangci-lint
on: on:
push: push:
tags:
- v*
branches: branches:
- master - master
- main - main
@ -122,7 +120,7 @@ jobs:
# #
# Note: by default the `.golangci.yml` file should be at the root of the repository. # Note: by default the `.golangci.yml` file should be at the root of the repository.
# The location of the configuration file can be changed by using `--config=` # The location of the configuration file can be changed by using `--config=`
# args: --config=/my/path/.golangci.yml --issues-exit-code=0 # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
# Optional: show only new issues if it's a pull request. The default value is `false`. # Optional: show only new issues if it's a pull request. The default value is `false`.
# only-new-issues: true # only-new-issues: true