M.V. Hutz
581f26f562
Some checks failed
CI / Check PR Title (push) Failing after 18s
CI / Makefile Lint (push) Successful in 33s
CI / Markdown Lint (push) Successful in 22s
CI / Unit Tests (push) Successful in 30s
CI / Go Lint (push) Successful in 45s
CI / Mutation Tests (push) Successful in 1m18s
CI / Fuzz Tests (push) Successful in 1m48s
## Description Currently, the repository is not well suited for semantic versioning, and hasn't much to support it. This PR adds templates, CI jobs, and configs to simplify its adoption. ## Changes - Added `FEATURE` and `BUG` issue templates. Also, forbids free-form issues. - Adds a PR template. - Adds a CI job to ensure the commit title follows conventional commits. ### Design Decisions N/A. ## Checklist - [x] Tests pass - [x] Docs updated Reviewed-on: #15 Co-authored-by: M.V. Hutz <git@maximhutz.me> Co-committed-by: M.V. Hutz <git@maximhutz.me>
102 lines
2.2 KiB
YAML
102 lines
2.2 KiB
YAML
name: CI
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
|
|
jobs:
|
|
check-pr-title:
|
|
name: Check PR Title
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: |
|
|
TITLE="${{ gitea.event.pull_request.title }}"
|
|
if ! echo "$TITLE" | grep -qE '^(WIP: )?(feat|fix|docs|chore|ci|test|refactor|perf|build|style|revert)(\(.+\))?(!)?: .+'; then
|
|
echo "::error::Pull Request title must follow conventional commits"
|
|
exit 1
|
|
fi
|
|
|
|
lint-go:
|
|
name: Go Lint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-go@v5
|
|
with:
|
|
go-version-file: go.mod
|
|
|
|
- name: Check go mod tidy
|
|
run: go mod tidy && git diff --exit-code go.mod go.sum
|
|
|
|
- uses: golangci/golangci-lint-action@v7
|
|
with:
|
|
version: latest
|
|
|
|
lint-makefile:
|
|
name: Makefile Lint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-go@v5
|
|
with:
|
|
go-version-file: go.mod
|
|
|
|
- name: Install gremlins
|
|
run: go install github.com/checkmake/checkmake/cmd/checkmake@latest
|
|
|
|
- name: Run mutation tests
|
|
run: make lint-makefile
|
|
|
|
lint-markdown:
|
|
name: Markdown Lint
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: DavidAnson/markdownlint-cli2-action@v19
|
|
|
|
test-unit:
|
|
name: Unit Tests
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-go@v5
|
|
with:
|
|
go-version-file: go.mod
|
|
|
|
- name: Run unit tests
|
|
run: make test-unit
|
|
|
|
test-fuzz:
|
|
name: Fuzz Tests
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-go@v5
|
|
with:
|
|
go-version-file: go.mod
|
|
|
|
- name: Run fuzz tests
|
|
run: make test-fuzz
|
|
|
|
test-mutation:
|
|
name: Mutation Tests
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-go@v5
|
|
with:
|
|
go-version-file: go.mod
|
|
|
|
- name: Install gremlins
|
|
run: go install github.com/go-gremlins/gremlins/cmd/gremlins@latest
|
|
|
|
- name: Run mutation tests
|
|
run: make test-mutation
|