Skip to content

Commit 2c9bcda

Browse files
authored
⬆️ Update quantecon/actions to v0.6.0 (#38)
* ⬆️ Update quantecon/actions to v0.6.0 - Update all workflow files to use pinned version v0.6.0 - Ensures Dependabot can track and update versions - Improves build reproducibility * 📝 Add Copilot instructions for gh CLI usage - Document best practice for using gh CLI with temporary files - Add .tmp/ directory to .gitignore for temporary files - Prevents shell escaping issues in zsh
1 parent 467eefd commit 2c9bcda

File tree

5 files changed

+42
-10
lines changed

5 files changed

+42
-10
lines changed

.github/copilot-instructions.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# GitHub Copilot Instructions
2+
3+
## GitHub CLI (gh) Usage
4+
5+
**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.
6+
7+
### Best Practice
8+
9+
Instead of:
10+
```bash
11+
gh pr create --title "Title" --body "Multi-line
12+
description with special characters"
13+
```
14+
15+
Do this:
16+
```bash
17+
# Write description to temporary file
18+
cat > .tmp/pr-description.md << 'EOF'
19+
Multi-line description
20+
with special characters
21+
EOF
22+
23+
# Use the file
24+
gh pr create --title "Title" --body-file .tmp/pr-description.md
25+
```
26+
27+
### Temporary Files
28+
29+
- Use `.tmp/` directory for temporary files (e.g., PR descriptions, issue bodies)
30+
- This directory is gitignored and safe for temporary content
31+
- Clean up files after use if needed, or leave them for debugging

.github/workflows/cache.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
uses: actions/checkout@v4
2525

2626
- name: Build and Cache
27-
uses: quantecon/actions/build-jupyter-cache@v0
27+
uses: quantecon/actions/build-jupyter-cache@v0.6.0
2828
with:
2929
builders: 'html'
3030
source-dir: 'lectures'

.github/workflows/ci.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,29 @@ jobs:
2020

2121
- name: Restore Build Cache
2222
id: cache
23-
uses: quantecon/actions/restore-jupyter-cache@v0
23+
uses: quantecon/actions/restore-jupyter-cache@v0.6.0
2424
with:
2525
cache-type: 'build'
2626
source-dir: 'lectures'
2727
save-cache: 'true'
2828

2929
- name: Build PDF
30-
uses: quantecon/actions/build-lectures@v0.5.0
30+
uses: quantecon/actions/build-lectures@v0.6.0
3131
with:
3232
source-dir: 'lectures'
3333
builder: 'pdflatex'
3434
upload-failure-reports: true
3535

3636
- name: Build Notebooks
37-
uses: quantecon/actions/build-lectures@v0.5.0
37+
uses: quantecon/actions/build-lectures@v0.6.0
3838
with:
3939
source-dir: 'lectures'
4040
builder: 'jupyter'
4141
upload-failure-reports: true
4242

4343
- name: Build HTML
4444
id: build
45-
uses: quantecon/actions/build-lectures@v0
45+
uses: quantecon/actions/build-lectures@v0.6.0
4646
with:
4747
source-dir: 'lectures'
4848
builder: 'html'
@@ -51,7 +51,7 @@ jobs:
5151
upload-failure-reports: true
5252

5353
- name: Deploy to Netlify
54-
uses: quantecon/actions/preview-netlify@v0
54+
uses: quantecon/actions/preview-netlify@v0.6.0
5555
with:
5656
build-dir: ${{ steps.build.outputs.build-path }}
5757
netlify-auth-token: ${{ secrets.NETLIFY_AUTH_TOKEN }}

.github/workflows/publish.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ jobs:
2828
uses: actions/checkout@v4
2929

3030
- name: Build PDF
31-
uses: quantecon/actions/build-lectures@v0
31+
uses: quantecon/actions/build-lectures@v0.6.0
3232
with:
3333
source-dir: 'lectures'
3434
builder: 'pdflatex'
3535
upload-failure-reports: true
3636

3737
- name: Build Notebooks
38-
uses: quantecon/actions/build-lectures@v0
38+
uses: quantecon/actions/build-lectures@v0.6.0
3939
with:
4040
source-dir: 'lectures'
4141
builder: 'jupyter'
4242
upload-failure-reports: true
4343

4444
- name: Build HTML
4545
id: build
46-
uses: quantecon/actions/build-lectures@v0
46+
uses: quantecon/actions/build-lectures@v0.6.0
4747
with:
4848
source-dir: 'lectures'
4949
builder: 'html'
@@ -53,6 +53,6 @@ jobs:
5353

5454
- name: Deploy to GitHub Pages
5555
id: deploy
56-
uses: quantecon/actions/publish-gh-pages@v0
56+
uses: quantecon/actions/publish-gh-pages@v0.6.0
5757
with:
5858
build-dir: ${{ steps.build.outputs.build-path }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ lectures/_build
33
.ipynb_checkpoints/
44
.virtual_documents/
55
_build/*
6+
.tmp/

0 commit comments

Comments
 (0)