Merge pull request #21 from pancan21/main

Fix action errors when codecov is "n" and replaced hardcoded names with placeholders
fpgmaas · Nov 1, 2024 · 90de471 · 90de471
2 parents 7476427 + 379626d
commit 90de471
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/docs/features/codecov.md b/docs/features/codecov.md
@@ -25,3 +25,5 @@ coverage:
 ignore:
   - "foo/bar.py"
 ```
+
+If `codecov` is set to `"n"`, `pytest-cov` is not added to the development dependencies and the github actions won't produce a coverage report.
diff --git a/{{cookiecutter.project_name}}/.github/workflows/main.yml b/{{cookiecutter.project_name}}/.github/workflows/main.yml
@@ -44,7 +44,7 @@ jobs:
           python-version: {% raw %}${{ matrix.python-version }}{% endraw %}
 
       - name: Run tests
-        run: uv run python -m pytest tests --cov --cov-config=pyproject.toml --cov-report=xml
+        run: uv run python -m pytest tests {% if cookiecutter.codecov == "y" %}--cov --cov-config=pyproject.toml --cov-report=xml{%- endif %}
 
       - name: Check typing
         run: uv run mypy

diff --git a/{{cookiecutter.project_name}}/CONTRIBUTING.md b/{{cookiecutter.project_name}}/CONTRIBUTING.md
@@ -29,7 +29,7 @@ Anything tagged with "enhancement" and "help wanted" is open to whoever wants to
 
 ## Write Documentation
 
-Cookiecutter PyPackage could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+{{cookiecutter.project_name}} could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 ## Submit Feedback
 

diff --git a/{{cookiecutter.project_name}}/mkdocs.yml b/{{cookiecutter.project_name}}/mkdocs.yml
@@ -5,7 +5,7 @@ site_description: {{cookiecutter.project_description}}
 site_author: {{cookiecutter.author}}
 edit_uri: edit/main/docs/
 repo_name: {{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}
-copyright: Maintained by <a href="https://{{cookiecutter.author_github_handle}}.com">Florian</a>.
+copyright: Maintained by <a href="https://{{cookiecutter.author_github_handle}}.com">{{cookiecutter.author_github_handle}}</a>.
 
 nav:
   - Home: index.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,3 +25,5 @@ coverage: @@
     ignore:
       - "foo/bar.py"
     ```
+    If `codecov` is set to `"n"`, `pytest-cov` is not added to the development dependencies and the github actions won't produce a coverage report.