Skip to content

Commit be7d8f3

Browse files
committed
Fix documentation deployment for MyST v2
- Use timeout command to handle MyST v2's server behavior in CI - Add Makefile to PR workflow paths to ensure CI runs - Document PR branch requirements in CLAUDE.md
1 parent a9ae2fa commit be7d8f3

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

.github/workflows/pr_code_changes.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
- policyengine_us_data/**
1010
- tests/**
1111
- .github/workflows/**
12+
- Makefile
1213

1314
jobs:
1415
Lint:

CLAUDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,20 @@
2323
- **Line Length**: 79 characters max (Black configured in pyproject.toml)
2424
- **Python Version**: Targeting Python 3.11
2525

26+
## Git and PR Guidelines
27+
- **CRITICAL**: NEVER create PRs from personal forks - ALL PRs MUST be created from branches pushed to the upstream PolicyEngine repository
28+
- CI requires access to secrets that are not available to fork PRs for security reasons
29+
- Fork PRs will fail on data download steps and cannot be merged
30+
- Always create branches directly on the upstream repository:
31+
```bash
32+
git checkout main
33+
git pull upstream main
34+
git checkout -b your-branch-name
35+
git push -u upstream your-branch-name
36+
```
37+
- Use descriptive branch names like `fix-issue-123` or `add-feature-name`
38+
- Always run `make format` before committing
39+
2640
## CRITICAL RULES FOR ACADEMIC INTEGRITY
2741

2842
### NEVER FABRICATE DATA OR RESULTS

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ documentation:
3939
rm -rf _build .jupyter_cache && \
4040
rm -f _toc.yml && \
4141
myst clean && \
42-
myst build
42+
timeout 10 myst build --html || true
4343

4444
documentation-build:
4545
cd docs && \

changelog_entry.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- bump: patch
2+
changes:
3+
fixed:
4+
- Fixed documentation deployment for MyST v2 by using timeout command

0 commit comments

Comments
 (0)