Skip to content
This repository was archived by the owner on Sep 10, 2025. It is now read-only.

Commit a5eebb3

Browse files
AlexStocksAlexStocks
authored
Merge pull request #10 from CAICAIIs/feat/ci
feat(ci): add GitHub Actions CI, lint, license checks and tooling
2 parents 1ecc4ff + 4269c11 commit a5eebb3

7 files changed

Lines changed: 498 additions & 0 deletions

File tree

‎.github/dependabot.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one or more
2+
# contributor license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright ownership.
4+
# The ASF licenses this file to You under the Apache License, Version 2.0
5+
# (the "License"); you may not use this file except in compliance with
6+
# the License. You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
version: 2
17+
updates:
18+
# Enable version updates for Go
19+
- package-ecosystem: "gomod"
20+
directory: "/"
21+
schedule:
22+
interval: "weekly"
23+
day: "monday"
24+
time: "09:00"
25+
open-pull-requests-limit: 10
26+
reviewers:
27+
- "dubbogo/protoc-gen-go-triple-maintainers"
28+
assignees:
29+
- "dubbogo/protoc-gen-go-triple-maintainers"
30+
commit-message:
31+
prefix: "deps"
32+
include: "scope"
33+
labels:
34+
- "dependencies"
35+
- "go"
36+
ignore:
37+
# Ignore major version updates for these packages
38+
- dependency-name: "google.golang.org/protobuf"
39+
update-types: ["version-update:semver-major"]
40+
- dependency-name: "github.com/google/go-cmp"
41+
update-types: ["version-update:semver-major"]
42+
- dependency-name: "golang.org/x/xerrors"
43+
update-types: ["version-update:semver-major"]
44+
45+
# Enable version updates for GitHub Actions
46+
- package-ecosystem: "github-actions"
47+
directory: "/"
48+
schedule:
49+
interval: "weekly"
50+
day: "monday"
51+
time: "09:00"
52+
open-pull-requests-limit: 5
53+
reviewers:
54+
- "dubbogo/protoc-gen-go-triple-maintainers"
55+
assignees:
56+
- "dubbogo/protoc-gen-go-triple-maintainers"
57+
commit-message:
58+
prefix: "ci"
59+
include: "scope"
60+
labels:
61+
- "dependencies"
62+
- "github-actions"

‎.github/workflows/ci.yml‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- 'release-*'
8+
- 'feature-*'
9+
pull_request:
10+
branches: "*"
11+
12+
permissions:
13+
contents: read
14+
15+
jobs:
16+
license:
17+
name: Check License Header
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Check License Header
23+
uses: apache/skywalking-eyes/header@main
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
with:
27+
config: .licenserc.yaml
28+
mode: check
29+
30+
build:
31+
name: ${{ matrix.os }} - Go ${{ matrix.go_version }}
32+
runs-on: ${{ matrix.os }}
33+
strategy:
34+
matrix:
35+
go_version:
36+
- '1.20'
37+
- '1.21'
38+
- '1.22'
39+
os:
40+
- ubuntu-latest
41+
42+
steps:
43+
44+
- name: Setup Go ${{ matrix.go_version }}
45+
uses: actions/setup-go@v5
46+
with:
47+
go-version: ${{ matrix.go_version }}
48+
id: go
49+
50+
- name: Checkout
51+
uses: actions/checkout@v4
52+
53+
- name: Cache dependencies
54+
uses: actions/cache@v4
55+
with:
56+
path: |
57+
~/.cache/go-build
58+
~/go/pkg/mod
59+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
60+
restore-keys: |
61+
${{ runner.os }}-go-
62+
63+
- name: Merge code into the upstream
64+
if: ${{ github.event_name == 'pull_request' }}
65+
run: |
66+
git fetch origin $GITHUB_BASE_REF
67+
git checkout -b $GITHUB_BASE_REF origin/$GITHUB_BASE_REF
68+
git remote add devrepo https://github.com/${{github.event.pull_request.head.repo.full_name}}.git
69+
git fetch devrepo ${{github.event.pull_request.head.sha}}
70+
git config --global user.email "[email protected]"
71+
git config --global user.name "robot"
72+
git merge ${{github.event.pull_request.head.sha}}
73+
74+
- name: Install dependencies
75+
run: |
76+
go get -v -t -d ./...
77+
78+
# Removed code formatting enforcement to allow custom import style
79+
80+
- name: Verify
81+
run: |
82+
go mod tidy
83+
make verify
84+
85+
- name: Build
86+
run: |
87+
go build -v ./...
88+
89+
- name: Test
90+
run: |
91+
go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
92+
93+
- name: Upload coverage to Codecov
94+
uses: codecov/codecov-action@v4
95+
with:
96+
file: ./coverage.txt
97+
flags: unittests
98+
name: codecov-umbrella
99+
fail_ci_if_error: false

‎.github/workflows/golangci-lint.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: golangci-lint
2+
on:
3+
push:
4+
branches: "*"
5+
pull_request:
6+
branches: "*"
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
golangci:
13+
permissions:
14+
contents: read # for actions/checkout to fetch code
15+
pull-requests: read # for golangci/golangci-lint-action to fetch pull requests
16+
name: lint
17+
runs-on: ubuntu-latest
18+
strategy:
19+
matrix:
20+
golang:
21+
- "1.20"
22+
- "1.21"
23+
- "1.22"
24+
steps:
25+
- uses: actions/setup-go@v5
26+
with:
27+
go-version: ${{ matrix.golang }}
28+
- uses: actions/checkout@v4
29+
- name: golangci-lint
30+
uses: golangci/golangci-lint-action@v5
31+
with:
32+
# Use golangci-lint v1.x to match config schema
33+
version: v1.64.4
34+
args: --timeout=10m

‎.golangci.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one or more
2+
# contributor license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright ownership.
4+
# The ASF licenses this file to You under the Apache License, Version 2.0
5+
# (the "License"); you may not use this file except in compliance with
6+
# the License. You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
version: "2"
17+
linters:
18+
default: none
19+
enable:
20+
- govet
21+
- ineffassign
22+
- misspell
23+
- staticcheck
24+
- gosimple
25+
- unused
26+
- errcheck
27+
- goconst
28+
- gocyclo
29+
- gocritic
30+
- lll
31+
- dupl
32+
- depguard
33+
34+
linters-settings:
35+
depguard:
36+
rules:
37+
main:
38+
deny:
39+
- pkg: github.com/sirupsen/logrus
40+
desc: logging is allowed only by logutils.Log, logrus is allowed to use only in logutils package
41+
dupl:
42+
threshold: 100
43+
goconst:
44+
min-len: 2
45+
min-occurrences: 2
46+
gocritic:
47+
disabled-checks:
48+
- wrapperFunc
49+
- emptyStringTest
50+
- hugeParam
51+
- nestingReduce
52+
- octalLiteral
53+
- appendCombine
54+
- commentFormatting
55+
enabled-tags:
56+
- performance
57+
- style
58+
- experimental
59+
gocyclo:
60+
min-complexity: 30
61+
govet:
62+
enable:
63+
- shadow
64+
lll:
65+
line-length: 200
66+
misspell:
67+
locale: US
68+
ignore-words:
69+
- nto
70+
issues:
71+
# Skip issues in generated files; set to false if you want to lint them.
72+
exclude-generated: true
73+
exclude-rules:
74+
- linters:
75+
- gosec
76+
text: weak cryptographic primitive
77+
- linters:
78+
- staticcheck
79+
text: '(SA1019|ST1001):'
80+
# exclude-files uses regexes
81+
exclude-files:
82+
- '.*\.pb\.go$'
83+
- '.*\.triple\.go$'
84+
85+
run:
86+
skip-dirs:
87+
- test
88+
- examples
89+
- gen/generator
90+
- internal/old_triple
91+
92+
formatters:
93+
settings:
94+
# Keep formatter settings; the action installs and runs formatter separately
95+
goimports:
96+
local-prefixes:
97+
- github.com/dubbogo/protoc-gen-go-triple

‎.licenserc.yaml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one or more
2+
# contributor license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright ownership.
4+
# The ASF licenses this file to You under the Apache License, Version 2.0
5+
# (the "License"); you may not use this file except in compliance with
6+
# the License. You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
header:
17+
license:
18+
spdx-id: Apache-2.0
19+
content: |
20+
Licensed to the Apache Software Foundation (ASF) under one or more
21+
contributor license agreements. See the NOTICE file distributed with
22+
this work for additional information regarding copyright ownership.
23+
The ASF licenses this file to You under the Apache License, Version 2.0
24+
(the "License"); you may not use this file except in compliance with
25+
the License. You may obtain a copy of the License at
26+
27+
http://www.apache.org/licenses/LICENSE-2.0
28+
29+
Unless required by applicable law or agreed to in writing, software
30+
distributed under the License is distributed on an "AS IS" BASIS,
31+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
32+
See the License for the specific language governing permissions and
33+
limitations under the License.
34+
35+
paths-ignore:
36+
- '**/*.md'
37+
- '**/*.json'
38+
- '**/*.properties'
39+
- '**/*.proto'
40+
- '**/*.tpl'
41+
- '**/go.mod'
42+
- '**/go.sum'
43+
- '.git/'
44+
- '.github/**'
45+
- '.gitignore'
46+
- 'LICENSE'
47+
- 'test/**'
48+
- '**/*.pb.go'
49+
- '**/*.triple.go'
50+
51+
comment: on-failure
52+
53+
# If you don't want to check dependencies' license compatibility, remove the following part
54+
dependency:
55+
files:
56+
- go.mod

0 commit comments

Comments
 (0)