From cff686178f16e1ffdd5593a01af974cece823a25 Mon Sep 17 00:00:00 2001 From: Laurent Demailly Date: Wed, 20 Mar 2024 19:33:03 -0700 Subject: [PATCH 1/2] Switch to shared workflows --- .github/workflows/codeql-analysis.yml | 67 ---------- .github/workflows/gochecks.yml | 26 ---- .github/workflows/include.yml | 26 ++++ .github/workflows/releaser.yml | 38 ------ .gitignore | 2 + .golangci.yml | 169 -------------------------- Makefile | 9 +- 7 files changed, 36 insertions(+), 301 deletions(-) delete mode 100644 .github/workflows/codeql-analysis.yml delete mode 100644 .github/workflows/gochecks.yml create mode 100644 .github/workflows/include.yml delete mode 100644 .github/workflows/releaser.yml delete mode 100644 .golangci.yml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index e8e4feb..0000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,67 +0,0 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -# -# ******** NOTE ******** -# We have attempted to detect the languages in your repository. Please check -# the `language` matrix defined below to confirm you have the correct set of -# supported CodeQL languages. -# -name: "CodeQL" - -on: - push: - branches: [ main ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ main ] - schedule: - - cron: '42 20 * * 3' - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - permissions: - actions: read - contents: read - security-events: write - - strategy: - fail-fast: false - matrix: - language: [ 'go' ] - # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] - # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support - - steps: - - name: Checkout repository - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v3 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # pin@v2 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # pin@v2 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - # If the Autobuild fails above, remove it and uncomment the following three lines. - # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. - # - run: | - # echo "Run, Build Application using script" - # ./location_of_script_within_repo/buildscript.sh - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # pin@v2 diff --git a/.github/workflows/gochecks.yml b/.github/workflows/gochecks.yml deleted file mode 100644 index 3ddf683..0000000 --- a/.github/workflows/gochecks.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: go-checks - -on: - push: - branches: [main] - pull_request: - # The branches below must be a subset of the branches above - branches: [main] - -jobs: - check: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v3 - - name: Setup Go environment - uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # pin@v4 - with: - go-version: '1.21' - check-latest: true - - name: Run Vulncheck - run: | - go install golang.org/x/vuln/cmd/govulncheck@latest - govulncheck ./... - - name: Run golangci-lint - uses: golangci/golangci-lint-action@3cfe3a4abbb849e10058ce4af15d205b6da42804 # pin@v3 diff --git a/.github/workflows/include.yml b/.github/workflows/include.yml new file mode 100644 index 0000000..3aa5f2a --- /dev/null +++ b/.github/workflows/include.yml @@ -0,0 +1,26 @@ +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 }} diff --git a/.github/workflows/releaser.yml b/.github/workflows/releaser.yml deleted file mode 100644 index c387fb3..0000000 --- a/.github/workflows/releaser.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Release - -on: - push: - 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*' - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # This workflow contains a single job called "build" - build: - # The type of runner that the job will run on - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v3 - with: - fetch-depth: 0 - - name: Set up Go - uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # pin@v3 - with: - go-version: '1.21' - check-latest: true - - name: Log in to Docker Hub - uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # pin@v2 - with: - username: ${{ secrets.DOCKER_USER }} - password: ${{ secrets.DOCKER_TOKEN }} - - name: "GoReleaser Action" - uses: goreleaser/goreleaser-action@7ec5c2b0c6cdda6e8bbb49444bc797dd33d74dd8 # pin@v4 - with: - distribution: goreleaser - version: latest - args: release --rm-dist - env: - GITHUB_TOKEN: ${{ secrets.GH_PAT }} diff --git a/.gitignore b/.gitignore index 3b735ec..7d1191b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +.golangci.yml + # If you prefer the allow list template instead of the deny list, see community template: # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore # diff --git a/.golangci.yml b/.golangci.yml deleted file mode 100644 index 3847205..0000000 --- a/.golangci.yml +++ /dev/null @@ -1,169 +0,0 @@ -# Config for golangci-lint - -# output configuration options - -# all available settings of specific linters -linters-settings: - gocritic: - disabled-checks: - - ifElseChain - 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 - - # 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 diff --git a/Makefile b/Makefile index ab231df..100f628 100644 --- a/Makefile +++ b/Makefile @@ -3,6 +3,13 @@ all: tests manual-check tests: go test -v ./... +.golangci.yml: Makefile + curl -fsS -o .golangci.yml https://raw.githubusercontent.com/fortio/workflows/main/golangci.yml + +lint: .golangci.yml + golangci-lint run + + manual-check: @echo "=========== With Everything: ===========" go run ./levelsDemo 2>&1 | TZ=UTC go run -race . @@ -13,4 +20,4 @@ manual-check: @echo "=========== Without Color: ===========" go run ./levelsDemo 2>&1 | go run -race . -no-color -.PHONY: tests manual-check +.PHONY: tests manual-check lint From 75f7382e490386c4013ebfa1ee39d74bf9b134ff Mon Sep 17 00:00:00 2001 From: Laurent Demailly Date: Wed, 20 Mar 2024 19:36:18 -0700 Subject: [PATCH 2/2] Use correct description and fix up goreleaser files too --- .github/workflows/include.yml | 2 +- .gitignore | 1 + .goreleaser.yaml | 85 ----------------------------------- 3 files changed, 2 insertions(+), 86 deletions(-) delete mode 100644 .goreleaser.yaml diff --git a/.github/workflows/include.yml b/.github/workflows/include.yml index 3aa5f2a..4e3ff31 100644 --- a/.github/workflows/include.yml +++ b/.github/workflows/include.yml @@ -19,7 +19,7 @@ jobs: call-releaser: uses: fortio/workflows/.github/workflows/releaser.yml@main with: - description: "Fortio multi curl" + description: "Fortio log JSON to (colorized) text converter" secrets: GH_PAT: ${{ secrets.GH_PAT }} DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }} diff --git a/.gitignore b/.gitignore index 7d1191b..6526816 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .golangci.yml +.goreleaser.yaml # If you prefer the allow list template instead of the deny list, see community template: # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore diff --git a/.goreleaser.yaml b/.goreleaser.yaml deleted file mode 100644 index ca61904..0000000 --- a/.goreleaser.yaml +++ /dev/null @@ -1,85 +0,0 @@ -builds: - - env: - - CGO_ENABLED=0 - goos: - - linux - - windows - - darwin - goarch: - - amd64 - - arm64 -checksum: - name_template: "checksums.txt" -snapshot: - name_template: "{{ incpatch .Version }}-next" -changelog: - sort: asc - filters: - exclude: - - "^docs:" - - "^test:" -gomod: - proxy: true - mod: mod -dockers: - - image_templates: ["fortio/{{ .ProjectName }}:{{ .Version }}-amd64"] - use: buildx - goarch: amd64 - build_flag_templates: - - --platform=linux/amd64 - - image_templates: ["fortio/{{ .ProjectName }}:{{ .Version }}-arm64"] - use: buildx - goarch: arm64 - build_flag_templates: - - --platform=linux/arm64 -docker_manifests: -- - name_template: fortio/{{ .ProjectName }}:{{ .Version }} - image_templates: - - fortio/{{ .ProjectName }}:{{ .Version }}-amd64 - - fortio/{{ .ProjectName }}:{{ .Version }}-arm64 -- - name_template: fortio/{{ .ProjectName }}:latest - image_templates: - - fortio/{{ .ProjectName }}:{{ .Version }}-amd64 - - fortio/{{ .ProjectName }}:{{ .Version }}-arm64 -release: - prerelease: auto - mode: append -# .goreleaser.yaml -brews: - - - # GitHub/GitLab repository to push the formula to - tap: - owner: fortio - name: homebrew-tap - - # Git author used to commit to the repository. - # Defaults are shown. - commit_author: - name: goreleaserbot - email: bot@goreleaser.com - - # The project name and current git tag are used in the format string. - commit_msg_template: "Brew formula update for {{ .ProjectName }} version {{ .Tag }}" - - # Folder inside the repository to put the formula. - # Default is the root folder. - folder: Formula - - # Your app's homepage. - # Default is empty. - homepage: "https://fortio.org/" - - # Template of your app's description. - # Default is empty. - description: "Fortio log JSON to (colorized) text converter" - - # SPDX identifier of your app's license. - # Default is empty. - license: "Apache-2.0" - - # So you can `brew test` your formula. - # Default is empty. - test: | - assert_match version.to_s, shell_output("#{bin}/{{ .ProjectName }} -version")