Skip to content

add badges #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vr-ski merged 6 commits into from
Dec 21, 2025
Merged

add badges #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
173e46c
add badges
vr-ski Dec 21, 2025
3f7e306
badges: fix wrong syntax
vr-ski Dec 21, 2025
e1ac8c8
align badges; add test coverage to workflow
vr-ski Dec 21, 2025
c2d4828
fix ci-workflow task dependency
vr-ski Dec 21, 2025
f88ee18
add codecov token to workflow
vr-ski Dec 21, 2025
ad0e612
rearrange badges
vr-ski Dec 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions .github/workflows/reusable-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,34 @@ jobs:
fail-fast: false
steps:
- name: Checkout code
uses: actions/checkout@v5
uses: actions/checkout@v6

- uses: ./.github/actions/setup-python
with:
python-version: ${{ matrix.python-version }}

- name: Run tests with coverage
- name: Run tests
run: pytest

coverage:
needs: [unit-tests]
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v6

- uses: ./.github/actions/setup-python
with:
python-version: "3.11"

- name: Run tests with coverage
run: pytest --cov=./ --cov-report=xml

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}

build-package:
runs-on: ${{ matrix.os }}
strategy:
Expand All @@ -88,7 +107,7 @@ jobs:
run: pip install dist/*.whl

aggregate-results:
needs: [ruff-check, ruff-format, mypy, unit-tests, build-package ]
needs: [ruff-check, ruff-format, mypy, unit-tests, coverage, build-package ]
runs-on: ubuntu-latest
outputs:
overall-success: ${{ steps.aggregate.outputs.overall-success }}
Expand Down
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# TFTP Router Flasher

| Badges |
|--------|
| ![PyPI](https://img.shields.io/pypi/v/tftp-router-flasher) |
| ![License](https://img.shields.io/github/license/vr-ski/TFTPRouterFlasher) |
| ![Repo Size](https://img.shields.io/github/repo-size/vr-ski/TFTPRouterFlasher) |
| ![Supported Python versions](https://img.shields.io/pypi/pyversions/tftp-router-flasher) |
| ![CD](https://github.com/vr-ski/TFTPRouterFlasher/actions/workflows/reusable-cd-dev.yml/badge.svg) |
| ![Security Scan](https://github.com/vr-ski/TFTPRouterFlasher/actions/workflows/schedule-security.yml/badge.svg) |
| ![CI](https://github.com/vr-ski/TFTPRouterFlasher/actions/workflows/reusable-ci.yml/badge.svg) |
| ![Coverage](https://img.shields.io/codecov/c/github/vr-ski/TFTPRouterFlasher) |
**TFTP Router Flasher** is a cross-platform command-line tool for flashing firmware to routers using the TFTP protocol. It is designed to assist in firmware recovery for routers that support TFTP-based rescue modes, such as many ASUS RT-series models.

This tool is a modern rewrite of the original [arescue](https://github.com/jnissin/arescue) script by [Joonas Nissinen](https://github.com/jnissin). It has been updated for Python 3, refactored for clarity, and packaged as a CLI utility with improved logging, interface detection, and dependency management.
Expand Down