Skip to content

Commit a3af99b

Browse files
Add Github badges to README (#3)
This pull request integrates automated test coverage reporting with Coveralls.io and displays dynamic badges in the README files. Changes: - coverage is now automatically collected and reported on every push and pull request - included GitHub badges for test coverage, release version, CI status, primary language used in repo and license
1 parent 5a7af7f commit a3af99b

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

.github/workflows/test.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,13 @@ jobs:
4949
- name: "Measuring test coverage"
5050
run: "make test/cover"
5151

52+
- name: "Upload coverage to Coveralls"
53+
uses: "coverallsapp/github-action@v2"
54+
with:
55+
github-token: ${{ secrets.GITHUB_TOKEN }}
56+
file: "coverage.out"
57+
format: "golang"
58+
5259
### PERFORMANCE ###
5360

5461
performance:

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Synthetic Data Values Generator (SDVG)
22

3+
[![Release][release-badge]][release-url]
4+
[![CI][actions-badge]][actions-url]
5+
[![Coverage Status][test-coverage-badge]][test-coverage-url]
6+
[![Language][language-badge]][language-url]
7+
[![License][license-badge]][license-url]
8+
9+
[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg?filter=!latest
10+
[release-url]: https://github.com/tarantool/sdvg/releases
11+
[actions-badge]: https://img.shields.io/github/check-runs/tarantool/sdvg/master
12+
[actions-url]: https://github.com/tarantool/sdvg/actions
13+
[test-coverage-badge]: https://img.shields.io/coverallsCoverage/github/tarantool/sdvg?branch=master
14+
[test-coverage-url]: https://coveralls.io/github/tarantool/sdvg?branch=master
15+
[language-badge]: https://img.shields.io/github/languages/top/tarantool/sdvg
16+
[language-url]: https://github.com/tarantool/sdvg/search?l=go
17+
[license-badge]: https://img.shields.io/github/license/tarantool/sdvg
18+
[license-url]: ./LICENSE
19+
320
## Language
421

522
- **English**

README.ru.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Synthetic Data Values Generator (SDVG)
22

3+
[![Release][release-badge]][release-url]
4+
[![CI][actions-badge]][actions-url]
5+
[![Coverage Status][test-coverage-badge]][test-coverage-url]
6+
[![Language][language-badge]][language-url]
7+
[![License][license-badge]][license-url]
8+
9+
[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg?filter=!latest
10+
[release-url]: https://github.com/tarantool/sdvg/releases
11+
[actions-badge]: https://img.shields.io/github/check-runs/tarantool/sdvg/master
12+
[actions-url]: https://github.com/tarantool/sdvg/actions
13+
[test-coverage-badge]: https://img.shields.io/coverallsCoverage/github/tarantool/sdvg?branch=master
14+
[test-coverage-url]: https://coveralls.io/github/tarantool/sdvg?branch=master
15+
[language-badge]: https://img.shields.io/github/languages/top/tarantool/sdvg
16+
[language-url]: https://github.com/tarantool/sdvg/search?l=go
17+
[license-badge]: https://img.shields.io/github/license/tarantool/sdvg
18+
[license-url]: ./LICENSE
19+
320
## Язык
421

522
- [English](README.md)

0 commit comments

Comments
 (0)