Spaces:
Sleeping
Sleeping
Seth McKnight
commited on
Commit
·
df316c5
1
Parent(s):
9c1cf16
Update deployment documentation and validate CI/CD checks (#6)
Browse files* ci: test CI/CD checks
* Update deployment documentation and mark deployment validation as complete
* ci: remove duplicate pre-commit-check job
* ci: ensure fetch-depth is set to 0 for all checkout steps
- .github/workflows/main.yml +6 -19
- deployed.md +5 -1
- project-plan.md +1 -1
.github/workflows/main.yml
CHANGED
|
@@ -14,6 +14,8 @@ jobs:
|
|
| 14 |
steps:
|
| 15 |
- name: Checkout code
|
| 16 |
uses: actions/checkout@v4
|
|
|
|
|
|
|
| 17 |
- name: Cache pip (dev)
|
| 18 |
uses: actions/cache@v4
|
| 19 |
with:
|
|
@@ -46,6 +48,8 @@ jobs:
|
|
| 46 |
steps:
|
| 47 |
- name: Checkout code
|
| 48 |
uses: actions/checkout@v4
|
|
|
|
|
|
|
| 49 |
- name: Set up Python
|
| 50 |
uses: actions/setup-python@v5
|
| 51 |
with:
|
|
@@ -68,25 +72,6 @@ jobs:
|
|
| 68 |
- name: Run tests
|
| 69 |
run: |
|
| 70 |
pytest
|
| 71 |
-
|
| 72 |
-
pre-commit-check:
|
| 73 |
-
name: Pre-commit checks (PR only)
|
| 74 |
-
runs-on: ubuntu-latest
|
| 75 |
-
steps:
|
| 76 |
-
- name: Checkout code
|
| 77 |
-
uses: actions/checkout@v4
|
| 78 |
-
- name: Set up Python
|
| 79 |
-
uses: actions/setup-python@v5
|
| 80 |
-
with:
|
| 81 |
-
python-version: "3.10"
|
| 82 |
-
- name: Install dev dependencies
|
| 83 |
-
run: |
|
| 84 |
-
python -m pip install --upgrade pip
|
| 85 |
-
pip install -r dev-requirements.txt
|
| 86 |
-
- name: Run pre-commit (fail if any hook fails)
|
| 87 |
-
run: |
|
| 88 |
-
pre-commit run --all-files --show-diff-on-failure
|
| 89 |
-
|
| 90 |
deploy-to-render:
|
| 91 |
name: Deploy to Render + Smoke Test
|
| 92 |
runs-on: ubuntu-latest
|
|
@@ -99,6 +84,8 @@ jobs:
|
|
| 99 |
steps:
|
| 100 |
- name: Checkout
|
| 101 |
uses: actions/checkout@v4
|
|
|
|
|
|
|
| 102 |
|
| 103 |
- name: Install jq (for JSON parsing)
|
| 104 |
run: sudo apt-get update && sudo apt-get install -y jq
|
|
|
|
| 14 |
steps:
|
| 15 |
- name: Checkout code
|
| 16 |
uses: actions/checkout@v4
|
| 17 |
+
with:
|
| 18 |
+
fetch-depth: 0
|
| 19 |
- name: Cache pip (dev)
|
| 20 |
uses: actions/cache@v4
|
| 21 |
with:
|
|
|
|
| 48 |
steps:
|
| 49 |
- name: Checkout code
|
| 50 |
uses: actions/checkout@v4
|
| 51 |
+
with:
|
| 52 |
+
fetch-depth: 0
|
| 53 |
- name: Set up Python
|
| 54 |
uses: actions/setup-python@v5
|
| 55 |
with:
|
|
|
|
| 72 |
- name: Run tests
|
| 73 |
run: |
|
| 74 |
pytest
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 75 |
deploy-to-render:
|
| 76 |
name: Deploy to Render + Smoke Test
|
| 77 |
runs-on: ubuntu-latest
|
|
|
|
| 84 |
steps:
|
| 85 |
- name: Checkout
|
| 86 |
uses: actions/checkout@v4
|
| 87 |
+
with:
|
| 88 |
+
fetch-depth: 0
|
| 89 |
|
| 90 |
- name: Install jq (for JSON parsing)
|
| 91 |
run: sudo apt-get update && sudo apt-get install -y jq
|
deployed.md
CHANGED
|
@@ -1,3 +1,7 @@
|
|
| 1 |
# Deployed Application
|
| 2 |
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# Deployed Application
|
| 2 |
|
| 3 |
+
Live URL: https://msse-ai-engineering.onrender.com/
|
| 4 |
+
|
| 5 |
+
Deployed at: 2025-10-11T23:49:00-06:00
|
| 6 |
+
|
| 7 |
+
Commit: 3d00f86
|
project-plan.md
CHANGED
|
@@ -28,7 +28,7 @@ This plan outlines the steps to design, build, and deploy a Retrieval-Augmented
|
|
| 28 |
- Installs dependencies from `requirements.txt`.
|
| 29 |
- Runs the `pytest` test suite.
|
| 30 |
- On success, triggers a deployment to Render.
|
| 31 |
-
- [
|
| 32 |
- [ ] **Documentation:** Update `deployed.md` with the live URL of the deployed application.
|
| 33 |
|
| 34 |
### CI/CD optimizations added
|
|
|
|
| 28 |
- Installs dependencies from `requirements.txt`.
|
| 29 |
- Runs the `pytest` test suite.
|
| 30 |
- On success, triggers a deployment to Render.
|
| 31 |
+
- [x] **Deployment Validation:** Push a change and verify that the workflow runs successfully and the application is deployed.
|
| 32 |
- [ ] **Documentation:** Update `deployed.md` with the live URL of the deployed application.
|
| 33 |
|
| 34 |
### CI/CD optimizations added
|