chore: Add CodeCov token to action and document usage

mbeacom · Feb 7, 2024 · f0a456f · f0a456f
1 parent fe9ef6c
commit f0a456f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml
@@ -49,6 +49,8 @@ jobs:
 
       - name: Codecov
         uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   security:
     name: Run Security Checks

diff --git a/README.md b/README.md
@@ -33,3 +33,20 @@ poetry install
 ```bash
 poetry run poe test
 ```
+
+## GitHub Actions Setup
+
+### Validation Workflow
+
+#### CodeCov.io
+
+The workflow is automatically setup to pass along coverage reports to CodeCov.io.
+In order for this to work correctly, you must set the `CODECOV_TOKEN` secret in your repository settings or disable the routine in the `.github/workflows/validate.yaml` file.
+
+### Publishing Workflow
+
+Ensure you have Discussions enabled in your repository settings or disable the discussions post attribute in the `.github/workflows/publish.yaml` file.
+
+#### PyPi
+
+The workflow is automatically setup to publish to PyPi. In order for this to work correctly, you must set the `POETRY_PYPI_TOKEN_PYPI` secret in your repository settings or disable the routine in the `.github/workflows/publish.yaml` file.