Skip to content

Commit

Permalink
Merge pull request #8 from salemove/add-ci-checks
Browse files Browse the repository at this point in the history
  • Loading branch information
take-five authored Jul 2, 2024
2 parents fc2e527 + fe6d1d0 commit 609f773
Show file tree
Hide file tree
Showing 10 changed files with 390 additions and 59 deletions.
72 changes: 49 additions & 23 deletions .github/workflows/release-on-master-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,67 @@ on:
branches:
- master

env:
# Common versions
GO_VERSION: '1.22.4'
GOLANGCI_LINT_VERSION: '1.59.1'

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}

- name: Lint
uses: golangci/golangci-lint-action@v6
with:
version: ${{ env.GOLANGCI_VERSION }}

- name: Run quality control checks
run: make vet

- name: Run tests
run: make test

build:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
os:
- linux
- darwin
arch:
- amd64
- arm64
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v3
uses: actions/setup-go@v5
with:
go-version: 1.18
go-version: ${{ env.GO_VERSION }}

- name: Create releases directory
run: mkdir releases

- name: Build for Linux (amd64)
run: go build -o ./releases/regexp_utility-$GOOS-$GOARCH regexp_utility.go
- name: Build
run: make build OUTPUT_PATH=releases/regexp_utility-${{ matrix.os }}-${{ matrix.arch }}
env:
GOOS: linux
GOARCH: amd64

- name: Build for Intel based Macs (amd64)
run: go build -o ./releases/regexp_utility-$GOOS-$GOARCH regexp_utility.go
env:
GOOS: darwin
GOARCH: amd64

- name: Build for Apple Silicon based Macs (arm64)
run: go build -o ./releases/regexp_utility-$GOOS-$GOARCH regexp_utility.go
env:
GOOS: darwin
GOARCH: arm64
GOOS: ${{ matrix.os }}
GOARCH: ${{ matrix.arch }}

release:
runs-on: ubuntu-latest
needs:
- test
- build
steps:
- name: Generate release tag
id: gen_tag
run: |
Expand All @@ -50,11 +78,9 @@ jobs:
git push origin master ${{ steps.gen_tag.outputs.release_tag }}
- name: Create GitHub release
uses: softprops/action-gh-release@v1
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ steps.gen_tag.outputs.release_tag }}
generate_release_notes: true
files: |
releases/regexp_utility-linux-amd64
releases/regexp_utility-darwin-amd64
releases/regexp_utility-darwin-arm64
releases/regexp_utility-*
35 changes: 23 additions & 12 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,34 @@ on:
branches:
- master

jobs:
env:
# Common versions
GO_VERSION: '1.22.4'
GOLANGCI_LINT_VERSION: 'v1.59.1'

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: false # The golangci-lint action does its own caching.

- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: 1.18
- name: Lint
uses: golangci/golangci-lint-action@v6
with:
version: ${{ env.GOLANGCI_VERSION }}

- name: Build
run: go build -v ./...
- name: Run quality control checks
run: make vet

- name: Check formatting
run: files=$(gofmt -l .) && [ -z "$files" ]
- name: Run tests
run: make test

- name: Test
run: go test -v ./...
- name: Build
run: make build
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# compiled executable
regexp_utility
bin
.cache
196 changes: 196 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
run:
allow-parallel-runners: true
timeout: 5m
concurrency: 4

output:
# colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
formats:
- format: colored-line-number

linters-settings:
errcheck:
# report about not checking of errors in type assetions: `a := b.(MyStruct)`;
# default is false: such cases aren't reported by default.
check-type-assertions: false

# report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
# default is false: such cases aren't reported by default.
check-blank: false

govet:
# report about shadowed variables
check-shadowing: false

gofmt:
# simplify code: gofmt with `-s` option, true by default
simplify: true

gci:
custom-order: true
sections:
- standard
- default
- blank
- dot

gocyclo:
# minimal code complexity to report, 30 by default (but we recommend 10-20)
min-complexity: 10

maligned:
# print struct with more effective memory layout or not, false by default
suggest-new: true

dupl:
# tokens count to trigger issue, 150 by default
threshold: 100

goconst:
# minimal length of string constant, 3 by default
min-len: 3
# minimal occurrences count to trigger, 3 by default
min-occurrences: 5

lll:
# tab width in spaces. Default to 1.
tab-width: 1

unparam:
# Inspect exported functions, default is false. Set to true if no external program/library imports your code.
# XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
# if it's called for subdir of a project it can't find external interfaces. All text editor integrations
# with golangci-lint call it on a directory with the changed file.
check-exported: false

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

prealloc:
# XXX: we don't recommend using this linter before doing performance profiling.
# For most programs usage of prealloc will be a premature optimization.

# Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
# True by default.
simple: true
range-loops: true # Report preallocation suggestions on range loops, true by default
for-loops: false # Report preallocation suggestions on for loops, false by default

gocritic:
# Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint` run to see all tags and checks.
# Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
enabled-tags:
- performance

settings: # settings passed to gocritic
captLocal: # must be valid enabled check name
paramsOnly: true
rangeValCopy:
sizeThreshold: 32

nolintlint:
require-explanation: true
require-specific: true


linters:
enable:
- govet
- gocyclo
- gocritic
- goconst
- gosimple
- gci
- gofmt # We enable this as well as goimports for its simplify mode.
- prealloc
- unconvert
- misspell
- nakedret
- nolintlint
- staticcheck
- unused

presets:
- bugs
- unused
fast: false


issues:
exclude-files:
- "zz_generated\\..+\\.go$"

# Excluding configuration per-path and per-linter
exclude-rules:
# Exclude some linters from running on tests files.
- path: _test(ing)?\.go
linters:
- gocyclo
- errcheck
- dupl
- gosec
- scopelint
- unparam

# Ease some gocritic warnings on test files.
- path: _test\.go
text: "(unnamedResult|exitAfterDefer)"
linters:
- gocritic

# These are performance optimisations rather than style issues per se.
# They warn when function arguments or range values copy a lot of memory
# rather than using a pointer.
- text: "(hugeParam|rangeValCopy):"
linters:
- gocritic

# This "TestMain should call os.Exit to set exit code" warning is not clever
# enough to notice that we call a helper method that calls os.Exit.
- text: "SA3000:"
linters:
- staticcheck

- text: "k8s.io/api/core/v1"
linters:
- goimports

# This is a "potential hardcoded credentials" warning. It's triggered by
# any variable with 'secret' in the same, and thus hits a lot of false
# positives in Kubernetes land where a Secret is an object type.
- text: "G101:"
linters:
- gosec
- gas

# This is an 'errors unhandled' warning that duplicates errcheck.
- text: "G104:"
linters:
- gosec
- gas

# Some k8s dependencies do not have JSON tags on all fields in structs.
- path: k8s.io/
linters:
- musttag

# Independently from option `exclude` we use default exclude patterns,
# it can be disabled by this option. To list all
# excluded by default patterns execute `golangci-lint run --help`.
# Default value for this option is true.
exclude-use-default: false

# Show only new issues: if there are unstaged changes or untracked files,
# only those changes are analyzed, else only changes in HEAD~ are analyzed.
# It's a super-useful option for integration of golangci-lint into existing
# large codebase. It's not practical to fix all existing issues at the moment
# of integration: much better don't allow issues in new code.
# Default is false.
new: false

# Maximum issues count per one linter. Set to 0 to disable. Default is 50.
max-per-linter: 0

# Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
max-same-issues: 0
Loading

0 comments on commit 609f773

Please sign in to comment.