From 71928b28c05519e19a3a2639b1e15694e24f49b3 Mon Sep 17 00:00:00 2001 From: Jekannadar Date: Thu, 9 Nov 2023 15:41:21 +0100 Subject: [PATCH] Update READMEs, Add coverage badge --- .github/workflows/generate-latest-release.yml | 2 +- .github/workflows/run-tests.yml | 1 - README.md | 3 ++- applications/cls-cad-backend/README.md | 2 ++ 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/workflows/generate-latest-release.yml b/.github/workflows/generate-latest-release.yml index ab96381..ea40b25 100644 --- a/.github/workflows/generate-latest-release.yml +++ b/.github/workflows/generate-latest-release.yml @@ -1,4 +1,4 @@ -name: Generate Latest Release +name: Test and Release on: push: diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml index c3b0316..d54ec77 100644 --- a/.github/workflows/run-tests.yml +++ b/.github/workflows/run-tests.yml @@ -31,7 +31,6 @@ jobs: if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' run: poetry install --with docker --no-interaction - name: Install dependencies - if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' run: touch cls_cad_backend/database/container - name: Test with pytest run: poetry run pytest --cov=. --cov-report=xml diff --git a/README.md b/README.md index 5707120..babaeaf 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Supported systems](https://img.shields.io/badge/os-windows-informational.svg)](https://shields.io/) [![GitHub license](https://img.shields.io/github/license/tudo-seal/CLS-CAD)](https://github.com/tudo-seal/CLS-CAD/blob/main/LICENSE) ![Generate Latest Release](https://github.com/tudo-seal/CLS-CAD/actions/workflows/generate-latest-release.yml/badge.svg) +[![CodeCov](https://codecov.io/gh/tudo-seal/CLS-CAD/graph/badge.svg)](https://codecov.io/gh/tudo-seal/CLS-CAD) @@ -31,7 +32,7 @@ Create an [Autodesk account](https://www.autodesk.com/education/edu-software). A Launch Fusion 360, Sign in, and then close Fusion 360. - Install the add-in using the [latest installer](https://github.com/tudo-seal/CLS-CAD/releases/download/latest/cls-cad-fusion-plugin.msi). -- Run the backend (as detailed in the Installation section) +- Run the backend (using docker, as detailed in the Installation section) - Download the [modular components for synthesizing robotic arms](https://doi.org/10.5281/zenodo.10051244) dataset. - Launch Fusion 360 and create a new empty project. Open that project. - Upload all .f3d files from the [modular components for synthesizing robotic arms](https://doi.org/10.5281/zenodo.10051244) to that project. diff --git a/applications/cls-cad-backend/README.md b/applications/cls-cad-backend/README.md index 33d8b29..4365095 100644 --- a/applications/cls-cad-backend/README.md +++ b/applications/cls-cad-backend/README.md @@ -1,5 +1,7 @@ # CLS-CAD Backend +--- + [![Generic badge](https://img.shields.io/badge/python-3.10%20|%203.11-informational.svg)](https://shields.io/) # Installation