-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
201 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,34 @@ | ||
# workflows | ||
Workflows reused across the go repos, to avoid dozens of same dependabot bumps | ||
|
||
The goreleaser and golangci-lint configs are shared and downloaded by the respective steps | ||
|
||
A typical use is to setup the following (see for instance https://github.com/fortio/multicurl setup) | ||
```yaml | ||
name: "Shared cli fortio workflows" | ||
on: | ||
push: | ||
branches: [ main ] | ||
tags: | ||
# so a vX.Y.Z-test1 doesn't trigger build | ||
- 'v[0-9]+.[0-9]+.[0-9]+' | ||
- 'v[0-9]+.[0-9]+.[0-9]+-pre*' | ||
pull_request: | ||
branches: [ main ] | ||
|
||
jobs: | ||
call-gochecks: | ||
uses: fortio/workflows/.github/workflows/gochecks.yml@main | ||
call-codecov: | ||
uses: fortio/workflows/.github/workflows/codecov.yml@main | ||
call-codeql: | ||
uses: fortio/workflows/.github/workflows/codeql-analysis.yml@main | ||
call-releaser: | ||
uses: fortio/workflows/.github/workflows/releaser.yml@main | ||
with: | ||
description: "Fortio multi curl" | ||
secrets: | ||
GH_PAT: ${{ secrets.GH_PAT }} | ||
DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }} | ||
DOCKER_USER: ${{ secrets.DOCKER_USER }} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
# Config for golangci-lint - shared across fortio org projects (included by gochecks workflow step) | ||
|
||
# output configuration options | ||
|
||
# all available settings of specific linters | ||
linters-settings: | ||
dupl: | ||
# tokens count to trigger issue, 150 by default | ||
threshold: 100 | ||
exhaustive: | ||
# indicates that switch statements are to be considered exhaustive if a | ||
# 'default' case is present, even if all enum members aren't listed in the | ||
# switch | ||
default-signifies-exhaustive: false | ||
funlen: | ||
lines: 140 | ||
statements: 70 | ||
gocognit: | ||
# minimal code complexity to report, 30 by default (but we recommend 10-20) | ||
min-complexity: 42 | ||
nestif: | ||
# minimal complexity of if statements to report, 5 by default | ||
min-complexity: 4 | ||
gocyclo: | ||
# minimal code complexity to report, 30 by default (but we recommend 10-20) | ||
min-complexity: 30 | ||
godot: | ||
# check all top-level comments, not only declarations | ||
check-all: false | ||
govet: | ||
# report about shadowed variables | ||
check-shadowing: true | ||
# settings per analyzer | ||
settings: | ||
printf: # analyzer name, run `go tool vet help` to see all analyzers | ||
funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer | ||
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof | ||
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf | ||
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf | ||
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf | ||
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Printf | ||
- (github.com/golangci/golangci-lint/pkg/logutils.Log).FErrf | ||
enable-all: true | ||
disable-all: false | ||
lll: | ||
# max line length, lines longer will be reported. Default is 120. | ||
# '\t' is counted as 1 character by default, and can be changed with the tab-width option | ||
line-length: 132 | ||
# tab width in spaces. Default to 1. | ||
tab-width: 1 | ||
misspell: | ||
# Correct spellings using locale preferences for US or UK. | ||
# Default is to use a neutral variety of English. | ||
# Setting locale to US will correct the British spelling of 'colour' to 'color'. | ||
locale: US | ||
ignore-words: | ||
- fortio | ||
nakedret: | ||
# make an issue if func has more lines of code than this setting and it has naked returns; default is 30 | ||
max-func-lines: 30 | ||
nolintlint: | ||
require-specific: true | ||
whitespace: | ||
multi-if: false # Enforces newlines (or comments) after every multi-line if statement | ||
multi-func: false # Enforces newlines (or comments) after every multi-line function signature | ||
gofumpt: | ||
# Choose whether or not to use the extra rules that are disabled | ||
# by default | ||
extra-rules: false | ||
|
||
|
||
linters: | ||
disable: | ||
# bad ones: | ||
- musttag | ||
# Deprecated ones: | ||
- scopelint | ||
- golint | ||
- interfacer | ||
- maligned | ||
- varcheck | ||
- structcheck | ||
- nosnakecase | ||
- deadcode | ||
# Weird/bad ones: | ||
- wsl | ||
- nlreturn | ||
- gochecknoinits | ||
- gochecknoglobals | ||
- gomnd | ||
- testpackage | ||
- wrapcheck | ||
- exhaustivestruct | ||
- tagliatelle | ||
- nonamedreturns | ||
- varnamelen | ||
- exhaustruct # seems like a good idea at first but actually a pain and go does have zero values for a reason. | ||
# TODO consider putting these back, when they stop being bugged (ifshort, wastedassign,...) | ||
- paralleltest | ||
- thelper | ||
- forbidigo | ||
- ifshort | ||
- wastedassign | ||
- cyclop | ||
- forcetypeassert | ||
- ireturn | ||
- depguard | ||
enable-all: true | ||
disable-all: false | ||
# Must not use fast: true in newer golangci-lint or it'll just skip a bunch of linter instead of doing caching like before (!) | ||
fast: false | ||
|
||
|
||
issues: | ||
# Excluding configuration per-path, per-linter, per-text and per-source | ||
exclude-rules: | ||
# Exclude some linters from running on tests files. | ||
- path: _test\.go | ||
linters: | ||
- gocyclo | ||
- errcheck | ||
- dupl | ||
- gosec | ||
- gochecknoinits | ||
- gochecknoglobals | ||
- forcetypeassert | ||
- nosnakecase | ||
- noctx | ||
- goconst | ||
|
||
# Exclude lll issues for long lines with go:generate | ||
- linters: | ||
- lll | ||
source: "^//go:generate " | ||
- linters: | ||
- goerr113 | ||
text: "do not define dynamic errors" | ||
- linters: | ||
- govet | ||
text: "fieldalignment:" | ||
- linters: | ||
- godox | ||
text: "TODO" | ||
- linters: | ||
- nosnakecase | ||
text: "grpc_|_SERVING|O_" | ||
|
||
# Maximum issues count per one linter. Set to 0 to disable. Default is 50. | ||
max-issues-per-linter: 0 | ||
|
||
# Maximum count of issues with the same text. Set to 0 to disable. Default is 3. | ||
max-same-issues: 0 | ||
|
||
severity: | ||
# Default value is empty string. | ||
# Set the default severity for issues. If severity rules are defined and the issues | ||
# do not match or no severity is provided to the rule this will be the default | ||
# severity applied. Severities should match the supported severity names of the | ||
# selected out format. | ||
# - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity | ||
# - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity | ||
# - Github: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message | ||
default-severity: error | ||
|
||
# The default value is false. | ||
# If set to true severity-rules regular expressions become case sensitive. | ||
case-sensitive: false |