Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# GitHub Copilot Instructions

## GitHub CLI (gh) Usage

**Important:** Shell escaping in zsh doesn't work reliably when passing multi-line strings or complex text directly to `gh` commands. Always write PR/issue descriptions to a temporary file first, then reference the file.

### Best Practice

Instead of:
```bash
gh pr create --title "Title" --body "Multi-line
description with special characters"
```

Do this:
```bash
# Write description to temporary file
cat > .tmp/pr-description.md << 'EOF'
Multi-line description
with special characters
EOF

# Use the file
gh pr create --title "Title" --body-file .tmp/pr-description.md
```

### Temporary Files

- Use `.tmp/` directory for temporary files (e.g., PR descriptions, issue bodies)
- This directory is gitignored and safe for temporary content
- Clean up files after use if needed, or leave them for debugging
2 changes: 1 addition & 1 deletion .github/workflows/cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
uses: actions/checkout@v4

- name: Build and Cache
uses: quantecon/actions/build-jupyter-cache@v0
uses: quantecon/actions/build-jupyter-cache@v0.6.0
with:
builders: 'html'
source-dir: 'lectures'
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,29 @@ jobs:

- name: Restore Build Cache
id: cache
uses: quantecon/actions/restore-jupyter-cache@v0
uses: quantecon/actions/restore-jupyter-cache@v0.6.0
with:
cache-type: 'build'
source-dir: 'lectures'
save-cache: 'true'

- name: Build PDF
uses: quantecon/actions/build-lectures@v0.5.0
uses: quantecon/actions/build-lectures@v0.6.0
with:
source-dir: 'lectures'
builder: 'pdflatex'
upload-failure-reports: true

- name: Build Notebooks
uses: quantecon/actions/build-lectures@v0.5.0
uses: quantecon/actions/build-lectures@v0.6.0
with:
source-dir: 'lectures'
builder: 'jupyter'
upload-failure-reports: true

- name: Build HTML
id: build
uses: quantecon/actions/build-lectures@v0
uses: quantecon/actions/build-lectures@v0.6.0
with:
source-dir: 'lectures'
builder: 'html'
Expand All @@ -51,7 +51,7 @@ jobs:
upload-failure-reports: true

- name: Deploy to Netlify
uses: quantecon/actions/preview-netlify@v0
uses: quantecon/actions/preview-netlify@v0.6.0
with:
build-dir: ${{ steps.build.outputs.build-path }}
netlify-auth-token: ${{ secrets.NETLIFY_AUTH_TOKEN }}
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ jobs:
uses: actions/checkout@v4

- name: Build PDF
uses: quantecon/actions/build-lectures@v0
uses: quantecon/actions/build-lectures@v0.6.0
with:
source-dir: 'lectures'
builder: 'pdflatex'
upload-failure-reports: true

- name: Build Notebooks
uses: quantecon/actions/build-lectures@v0
uses: quantecon/actions/build-lectures@v0.6.0
with:
source-dir: 'lectures'
builder: 'jupyter'
upload-failure-reports: true

- name: Build HTML
id: build
uses: quantecon/actions/build-lectures@v0
uses: quantecon/actions/build-lectures@v0.6.0
with:
source-dir: 'lectures'
builder: 'html'
Expand All @@ -53,6 +53,6 @@ jobs:

- name: Deploy to GitHub Pages
id: deploy
uses: quantecon/actions/publish-gh-pages@v0
uses: quantecon/actions/publish-gh-pages@v0.6.0
with:
build-dir: ${{ steps.build.outputs.build-path }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ lectures/_build
.ipynb_checkpoints/
.virtual_documents/
_build/*
.tmp/