Refactor README for clarity and conciseness #6

	name: Update Coverage Badge
	on:
	push:
	branches: [main]

	permissions:
	contents: write

	jobs:
	update-badge:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0

	- name: Setup Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	cache: "pip"

	- name: Install Dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -r requirements.txt
	pip install -r requirements-test.txt

	- name: Run tests
	run: \|
	pytest tests/ -v --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=minichain \| tee pytest-coverage.txt

	- name: Coverage comment
	id: coverage
	uses: MishaKav/pytest-coverage-comment@v1
	with:
	pytest-coverage-path: ./pytest-coverage.txt
	junitxml-path: ./pytest.xml
	hide-comment: true

	- name: Update README
	run: \|
	BADGE='${{ steps.coverage.outputs.coverageHtml }}'
	BADGE="${BADGE/.svg/.svg?style=for-the-badge}"
	sed -i "/<!-- Pytest Coverage Comment:Begin -->/,/<!-- Pytest Coverage Comment:End -->/c\<!-- Pytest Coverage Comment:Begin -->\n$BADGE\n<!-- Pytest Coverage Comment:End -->" ./README.md

	- name: Commit changes
	uses: stefanzweifel/git-auto-commit-action@v5
	with:
	commit_message: 'docs: update coverage badge'
	file_pattern: README.md

Navigation Menu