QuantEcon / QuantEcon/actions

lecture-python.myst: HTML-only PR previews; three-format build behind a full-preview label

Open
#148 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Shell
Stars
0
Forks
1
Avg merge
32m
Merged PRs (30d)
3

Description

Phase 1 critical path of #92 — this item alone outweighs every actions-repo item there combined. Work lands in QuantEcon/lecture-python.myst; expected saving −7–7.8 min against its measured 17-minute PR baseline.

Its .github/workflows/ci.yml still runs the notebook build (--custom-builder=jupyter, :72) and pdflatex (:84) on every PR, ungated — formats unused by a preview.

  • HTML-only build on every PR
  • Three-format build behind a full-preview label
  • PDF/notebook coverage moves to the weekly cache.yml
  • fetch-depth: 1 on the checkout (ci.yml:21, still fetch-depth: 0) — −80–95s measured; land together with the bounded-fetch change in the actions-repo quick-wins PR (#147), since a shallow checkout without bounded fetches makes them worse

Gated on the preview-SLA decision (what happens to the PDF/ipynb download buttons), not on effort — see the blocking issue #146.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with .github/workflows/ci.yml, especially the notebook build at line 72, pdflatex step at line 84, and checkout at line 21; compare the weekly cache.yml workflow. Confirm the preview-SLA decision in blocking issue #146 and coordinate with quick-wins PR #147. Done means PRs build HTML only, full three-format builds require the full-preview label, PDF/notebook coverage moves to cache.yml, and checkout uses fetch-depth: 1.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, jupyter, latex, shell
Domain
build-system, ci-cd, devops
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.