From 888e2b4033ba6dd99c28c59b1bf067f735464fba Mon Sep 17 00:00:00 2001
From: takline <tylerkline@gmail.com>
Date: Thu, 8 Aug 2024 14:37:42 +0000
Subject: [PATCH] v1.1 release

---
 tests/README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 48 insertions(+), 3 deletions(-)

diff --git a/tests/README.md b/tests/README.md
index c22772e..962fa6a 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -13,14 +13,59 @@ ResumeGPT tests are structured as follows:
 
 ## Running the Tests
 
-To run the tests, use the following command:
+```python
+To run the tests, use the following command:```python
+pytest tests/ --junitxml=tests/test-results.xml --tb=long -vv --cov=./ --cov-report=xml:tests/coverage.xml
+```
+
+or:
+
 
 ```python
 pytest
 ```
 
-Or:
+
+
+or:
 
 ```python
 pytest tests/test_services.py
-```
\ No newline at end of file
+```
+
+
+<br>
+
+## Continuous Integration and Deployment
+
+The CI/CD workflow is defined in [`.github/workflows/publish-to-pypi.yaml`](https://github.com/takline/ResumeGPT/blob/main/.github/workflows/publish-to-pypi.yaml).
+
+### Workflow Overview
+
+1. **Test Job**:
+    - **Checkout code**: Retrieves the latest code from the repository.
+    - **Set up Python**: Configures the Python environment.
+    - **Install dependencies**: Installs the required dependencies from `requirements.txt`.
+    - **Run tests with pytest**: Executes the tests and generates test results and coverage reports.
+    - **Upload test results**: Uploads the test results as an artifact.
+    - **Upload coverage results**: Uploads the coverage report as an artifact.
+    - **Annotate the test results**: Adds annotations to the test results for easier debugging.
+
+2. **Build Job**:
+    - **Build distribution**: Creates a binary wheel and a source tarball of the package.
+    - **Store the distribution packages**: Uploads the built distributions as artifacts.
+
+3. **GitHub Release Job**:
+    - **Sign the distributions**: Uses Sigstore to sign the distribution packages.
+    - **Create GitHub Release**: Creates a new release on GitHub.
+    - **Upload artifact signatures**: Uploads the signed artifacts to the GitHub release.
+
+4. **Publish to PyPI Job**:
+    - **Publish distribution to PyPI**: Publishes the signed distribution packages to PyPI.
+
+### Artifacts
+
+- **Test Results**: Stored as `tests/test-results.xml`.
+- **Coverage Report**: Stored as `tests/coverage.xml`.
+- **Distribution Packages**: Stored in the `dist/` directory and uploaded to GitHub and PyPI.
+