Merge pull request #13 from liuzengh/doc #47

	name: Pull Request Check
	on:
	pull_request:
	push:
	workflow_dispatch:
	permissions:
	contents: read
	pull-requests: read # Use with `only-new-issues` option.
	jobs:
	build:
	name: build
	runs-on: self-hosted
	steps:
	- uses: actions/checkout@v3
	- uses: actions/setup-go@v4
	with:
	go-version: 1.19
	- name: Build
	run: go build -v ./...
	- name: Test
	run: go test -v -coverprofile=coverage.out ./...
	- name: Upload coverage reports to Codecov
	uses: codecov/codecov-action@v3
	with:
	files: coverage.out
	flags: unittests
	env:
	CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
	golangci:
	name: lint
	runs-on: ubuntu-latest
	steps:
	- uses: actions/setup-go@v4
	with:
	go-version: 1.19
	- uses: actions/checkout@v3
	- name: golangci-lint
	uses: golangci/golangci-lint-action@v3
	with:
	version: latest
	args: --timeout=5m
	only-new-issues: true
	skip-cache: true # To prevent occasional failure of this action.
	typos:
	name: typos
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- name: typos
	uses: crate-ci/typos@master
	with:
	# https://github.com/crate-ci/typos#false-positives
	config: ./.github/typos.toml
	go-apidiff:
	if: github.event_name == 'pull_request'
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	with:
	fetch-depth: 0
	- uses: actions/setup-go@v4
	with:
	go-version: 1.19
	- uses: joelanford/go-apidiff@main

Provide feedback