Initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem.
+
+**Kitex version:**
+
+Please provide the version of Kitex you are using.
+
+**Environment:**
+
+The output of `go env`.
+
+**Additional context**
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+#### What type of PR is this?
+<!--
+Add one of the following kinds:
+
+build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+docs: Documentation only changes
+feat: A new feature
+optimize: A new optimization
+fix: A bug fix
+perf: A code change that improves performance
+refactor: A code change that neither fixes a bug nor adds a feature
+style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+test: Adding missing tests or correcting existing tests
+chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
+-->
+
+#### What this PR does / why we need it (en: English/zh: Chinese):
+<!--
+The description will be attached in Release Notes, 
+so please describe it from user-oriented.
+-->
+en: 
+zh:
+
+#### Which issue(s) this PR fixes:
+<!--
+*Automatically closes linked issue when PR is merged.
+Eg: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
+-->

.github/workflows/pr-check.yml

@@ -0,0 +1,60 @@
+name: Pull Request Check
+
+on: [ pull_request ]
+
+jobs:
+ compliant:
+ runs-on: [ self-hosted, X64 ]
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Check License Header
+ uses: apache/skywalking-eyes/header@main
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Check Spell
+ uses: crate-ci/typos@master
+
+ staticcheck:
+ runs-on: [ self-hosted, X64 ]
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Go
+ uses: actions/setup-go@v3
+ with:
+ go-version: 1.19
+
+ - uses: actions/cache@v3
+ with:
+ path: ~/go/pkg/mod
+ key: reviewdog-${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+ restore-keys: |
+ reviewdog-${{ runner.os }}-go-
+
+ - uses: reviewdog/action-staticcheck@v1
+ with:
+ github_token: ${{ secrets.github_token }}
+ # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
+ reporter: github-pr-review
+ # Report all results.
+ filter_mode: nofilter
+ # Exit with 1 when it find at least one finding.
+ fail_on_error: true
+ # Set staticcheck flags
+ staticcheck_flags: -checks=inherit,-SA1029
+
+ lint:
+ runs-on: [ self-hosted, X64 ]
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Go
+ uses: actions/setup-go@v3
+ with:
+ go-version: 1.19
+
+ - name: Golangci Lint
+ # https://golangci-lint.run/
+ uses: golangci/golangci-lint-action@v3
+ with:
+ version: latest

.github/workflows/release-check.yml

@@ -0,0 +1,25 @@
+name: Release Check
+
+on:
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Check Source Branch
+ run: python2 -c "exit(0 if '${{ github.head_ref }}'.startswith('release') or '${{ github.head_ref }}'.startswith('hotfix') else 1)"
+
+ - name: Check Version
+ run: |
+ # get version code, runner not support grep -E here
+ SOURCE_VERSION=`grep 'Version\s*=\s*\"v[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}\"' *.go | awk -F '\"' '{print $(NF-1)}'`
+ git checkout main
+ MASTER_VERSION=`grep 'Version\s*=\s*\"v[0-9]\{1,\}\.[0-9]\{1,\}\.[0-9]\{1,\}\"' *.go | awk -F '\"' '{print $(NF-1)}'`
+ git checkout ${{Head.SHA}}
+ # check version update
+ python2 -c "exit(0 if list(map(int,'${SOURCE_VERSION#v}'.split('.')[:3])) > list(map(int,'${MASTER_VERSION#v}'.split('.')[:3])) else 1)"

.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on: [ push, pull_request ]
+
+jobs:
+ unit-benchmark-test:
+ strategy:
+ matrix:
+ go: [ 1.17, 1.18, 1.19 ]
+ os: [ X64, ARM64 ]
+ runs-on: ${{ matrix.os }}
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Go
+ uses: actions/setup-go@v3
+ with:
+ go-version: ${{ matrix.go }}
+
+ # block scenario, comment temporarily
+# - uses: actions/cache@v3
+# with:
+# path: ~/go/pkg/mod
+# key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+# restore-keys: |
+# ${{ runner.os }}-go-
+
+ - name: Unit Test
+ run: go test -race -covermode=atomic -coverprofile=coverage.out ./...
+
+ - name: Benchmark
+ run: go test -bench=. -benchmem -run=none ./...

.gitignore

@@ -0,0 +1,30 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# the result of the go build
+output*
+output/*
+
+# Files generated by IDEs
+.idea/
+*.iml
+
+# Vim swap files
+*.swp
+
+# Vscode files
+.vscode
+

.golangci.yaml

@@ -0,0 +1,36 @@
+# Options for analysis running.
+run:
+ # include `vendor` `third_party` `testdata` `examples` `Godeps` `builtin`
+ skip-dirs-use-default: true
+ skip-dirs:
+ - kitex_gen
+ skip-files:
+ - ".*\\.mock\\.go$"
+# output configuration options
+output:
+ # Format: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
+ format: colored-line-number
+# All available settings of specific linters.
+# Refer to https://golangci-lint.run/usage/linters
+linters-settings:
+ gofumpt:
+ # Choose whether to use the extra rules.
+ # Default: false
+ extra-rules: true
+ govet:
+ # Disable analyzers by name.
+ # Run `go tool vet help` to see all analyzers.
+ disable:
+ - stdmethods
+linters:
+ enable:
+ - gofumpt
+ - gofmt
+ disable:
+ - errcheck
+ - typecheck
+ - deadcode
+ - varcheck
+ - staticcheck
+issues:
+ exclude-use-default: true

.licenserc.yaml

@@ -0,0 +1,10 @@
+header:
+ license:
+ spdx-id: Apache-2.0
+ copyright-owner: CloudWeGo Authors
+
+ paths:
+ - '**/*.go'
+ - '**/*.s'
+
+ comment: on-failure