From 7e6f3ad92ba28a9772bafd59a455e775c813bcd5 Mon Sep 17 00:00:00 2001 From: smilerz Date: Thu, 28 Dec 2023 18:00:55 -0600 Subject: [PATCH] add badges to README publish reports to gh-pages --- .github/workflows/docs.yml | 13 ++++++++----- .gitignore | 3 +-- README.md | 14 ++++++++------ pytest.ini | 2 +- 4 files changed, 18 insertions(+), 14 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6956ee7f0..086bb60d5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,12 +1,15 @@ name: Make Docs on: - push: - branches: - - master + # the 1st condition + workflow_run: + workflows: ["Continuous Integration"] + branches: [working] + types: + - completed jobs: deploy: - if: github.repository_owner == 'TandoorRecipes' + if: github.repository_owner == 'smilerz' && ${{ github.event.workflow_run.conclusion == 'success' }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -14,4 +17,4 @@ jobs: with: python-version: 3.x - run: pip install mkdocs-material mkdocs-include-markdown-plugin - - run: mkdocs gh-deploy --force \ No newline at end of file + - run: mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore index d5f366efe..143271c6c 100644 --- a/.gitignore +++ b/.gitignore @@ -43,8 +43,7 @@ htmlcov/ nosetests.xml coverage.xml *,cover -*/coverage/ -*/tests/ +docs/reports/** # Django stuff: *.log diff --git a/README.md b/README.md index 4398c00f1..583297f8e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ + +

@@ -39,13 +41,13 @@ - 🔍 Powerful & customizable **search** with fulltext support and [TrigramSimilarity](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity) - 🏷️ Create and search for **tags**, assign them in batch to all files matching certain filters -- ↔️ Quickly merge and rename ingredients, tags and units +- ↔️ Quickly merge and rename ingredients, tags and units - 📥️ **Import recipes** from thousands of websites supporting [ld+json or microdata](https://schema.org/Recipe) - ➗ Support for **fractions** or decimals - 🐳 Easy setup with **Docker** and included examples for **Kubernetes**, **Unraid** and **Synology** - 🎨 Customize your interface with **themes** - 📦 **Sync** files with Dropbox and Nextcloud - + ## All the must haves - 📱Optimized for use on **mobile** devices @@ -54,7 +56,7 @@ - ➕ Many more like recipe scaling, image compression, printing views and supermarkets This application is meant for people with a collection of recipes they want to share with family and friends or simply -store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as +store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as a public page. ## Docs @@ -62,13 +64,13 @@ a public page. Documentation can be found [here](https://docs.tandoor.dev/). ## Support our work -Tandoor is developed by volunteers in their free time just because its fun. That said earning +Tandoor is developed by volunteers in their free time just because its fun. That said earning some money with the project allows us to spend more time on it and thus make improvements we otherwise couldn't. Because of that there are several ways you can support us - **GitHub Sponsors** You can sponsor contributors of this project on GitHub: [vabene1111](https://github.com/sponsors/vabene1111) - **Host at Hetzner** We have been very happy customers of Hetzner for multiple years for all of our projects. If you want to get into self-hosting or are tired of the expensive big providers, their cloud servers are a great place to get started. When you sign up via our [referral link](https://hetzner.cloud/?ref=ISdlrLmr9kGj) you will get 20€ worth of cloud credits and we get a small kickback too. -- **Let us host for you** We are offering a [hosted version](https://app.tandoor.dev) where all profits support us and the development of tandoor (currently only available in germany). +- **Let us host for you** We are offering a [hosted version](https://app.tandoor.dev) where all profits support us and the development of tandoor (currently only available in germany). ## Contributing Contributions are welcome but please read [this](https://docs.tandoor.dev/contribute/#contributing-code) **BEFORE** contributing anything! @@ -100,7 +102,7 @@ Beginning with version 0.10.0 the code in this repository is licensed under the > I am in the process of getting some professional legal advice to sort out these issues. > Please also see [Issue 238](https://github.com/vabene1111/recipes/issues/238) for some discussion and **reasoning** regarding the topic. -**Reasoning** +**Reasoning** **This software and *all* its features are and will always be free for everyone to use and enjoy.** The reason for the selling exception is that a significant amount of time was spend over multiple years to develop this software. diff --git a/pytest.ini b/pytest.ini index 075ee1638..c1b192b40 100644 --- a/pytest.ini +++ b/pytest.ini @@ -1,4 +1,4 @@ [pytest] DJANGO_SETTINGS_MODULE = recipes.settings python_files = tests.py test_*.py *_tests.py -# addopts = --cov=. --cov-report=html:docs/coverage --cov-report=xml:docs/coverage/coverage.xml --junitxml=docs/tests/pytest.xml --html=docs/tests/tests.html +addopts = --cov=. --cov-report=html:docs/reports/coverage --cov-report=xml:docs/reports/coverage/coverage.xml --junitxml=docs/reports/tests/pytest.xml --html=docs/reports/tests/tests.html