Skip to content

Commit 8b5f1e6

Browse files
committed
Add CI badges, coverage tracking, and improve README with licenses info
1 parent 126b0b6 commit 8b5f1e6

2 files changed

Lines changed: 27 additions & 13 deletions

File tree

.github/workflows/test.yml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,29 @@ name: Tests
22

33
on:
44
push:
5-
branches: [ main, master ]
5+
branches: [ main ]
66
pull_request:
7-
branches: [ main, master ]
7+
branches: [ main ]
88

99
jobs:
1010
test:
11-
name: Test
11+
name: Test on Go ${{ matrix.go-version }}
1212
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
go-version: ["1.22", "1.23", "1.24"]
1316
steps:
1417
- name: Checkout code
15-
uses: actions/checkout@v6
18+
uses: actions/checkout@v4
1619

1720
- name: Setup Go
18-
uses: actions/setup-go@v6
21+
uses: actions/setup-go@v5
1922
with:
20-
go-version: "1.24"
23+
go-version: ${{ matrix.go-version }}
2124
cache: true
2225

2326
- name: Run tests
24-
run: go test -v -race -coverprofile=coverage.out $(go list ./... | grep -v '/examples')
27+
run: go test -v -race -coverprofile=coverage.out ./...
2528

2629
- name: Check coverage
2730
run: |
@@ -33,8 +36,8 @@ jobs:
3336
fi
3437
3538
- name: Upload coverage to Codecov
36-
uses: codecov/codecov-action@v6
39+
uses: codecov/codecov-action@v4
3740
with:
3841
files: ./coverage.out
3942
flags: unittests
40-
name: codecov-umbrella
43+
name: codecov-${{ matrix.go-version }}

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# confkit
22

3-
[![Go Version](https://img.shields.io/badge/go-1.24%2B-blue)](https://golang.org/doc/devel/release)
3+
[![Go Version](https://img.shields.io/badge/go-1.22%2B-blue)](https://golang.org/doc/devel/release)
44
[![Go Reference](https://pkg.go.dev/badge/github.com/MimoJanra/confkit.svg)](https://pkg.go.dev/github.com/MimoJanra/confkit)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
6-
[![GitHub Release](https://img.shields.io/github/v/release/MimoJanra/confkit.svg)](https://github.com/MimoJanra/confkit/releases)
5+
[![Tests](https://github.com/MimoJanra/confkit/actions/workflows/test.yml/badge.svg)](https://github.com/MimoJanra/confkit/actions/workflows/test.yml)
6+
[![codecov](https://codecov.io/gh/MimoJanra/confkit/branch/main/graph/badge.svg)](https://codecov.io/gh/MimoJanra/confkit)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
78
[![Go Report Card](https://goreportcard.com/badge/github.com/MimoJanra/confkit)](https://goreportcard.com/report/github.com/MimoJanra/confkit)
89
[![Documentation](https://img.shields.io/badge/docs-mimojanra.github.io-blue)](https://mimojanra.github.io/confkit/)
910
[![LLM Context](https://img.shields.io/badge/llms.txt-reference-brightgreen)](./llms.txt)
@@ -548,4 +549,14 @@ vault.VaultKubernetesAuth(role, jwt string) VaultAuth
548549

549550
## License
550551

551-
MIT
552+
MIT — A permissive, redistributable license with minimal restrictions.
553+
554+
confkit is released under the MIT License, which allows you to:
555+
- ✅ Use commercially (SaaS, proprietary software, etc.)
556+
- ✅ Modify and redistribute
557+
- ✅ Use in closed-source projects
558+
- ✅ Sublicense
559+
560+
The only requirement: include a copy of the license in your distribution.
561+
562+
See [LICENSE](LICENSE) file for full text.

0 commit comments

Comments
 (0)