Skip to content

Commit a4a580e

Browse files
mmckymmcky
committed
chore: bump action-translation v0.10.0 → v0.11.0
1 parent 3b2eb8c commit a4a580e

File tree

5 files changed

+166
-1
lines changed

5 files changed

+166
-1
lines changed

‎.github/workflows/review-translations.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
with:
1818
fetch-depth: 2
1919

20-
- uses: QuantEcon/action-translation@v0.10.0
20+
- uses: QuantEcon/action-translation@v0.11.0
2121
with:
2222
mode: review
2323
source-repo: QuantEcon/lecture-python-programming

‎.tmp/commit-msg.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Setup action-translation sync infrastructure
2+
3+
- Add .translate/ config and state files (25 lectures)
4+
- Add review-translations.yml workflow (v0.10.0)
5+
- Update heading-map keys to full-text format
6+
- Generate missing heading-maps (about_py, scipy, troubleshooting)

‎.tmp/pr-body.txt‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
3+
Sets up [action-translation](https://github.com/QuantEcon/action-translation) v0.10.0 infrastructure for automated sync with the English source repo.
4+
5+
## Changes
6+
7+
### `.translate/` directory (new)
8+
- `config.yml` — links to source repo `QuantEcon/lecture-python-programming`, target language `fa`, docs folder `lectures`
9+
- `state/*.yml` — 25 state files tracking source commit hashes for each lecture
10+
11+
### `.github/workflows/review-translations.yml` (new)
12+
- Triggers on PRs with `action-translation` label
13+
- Runs Claude-powered quality review on translation PRs
14+
- Uses `GITHUB_TOKEN` (no cross-repo access needed)
15+
16+
### Lecture heading-maps (updated)
17+
- 20 files: heading-map keys updated from slugified format to full heading text with `::` nesting
18+
- 3 files: missing heading-maps generated (`about_py.md`, `scipy.md`, `troubleshooting.md`)
19+
- Heading-maps enable cross-reference linking between English and Farsi headings
20+
21+
## How it works
22+
23+
Once this is merged and the corresponding sync workflow is added to the source repo:
24+
1. When a PR merges in the source repo touching `lectures/**/*.md`, the sync workflow detects changed sections
25+
2. Only changed sections are re-translated (not the whole file)
26+
3. A translation PR is automatically created in this repo
27+
4. The review workflow posts a quality assessment comment on the translation PR

‎.tmp/pr66-review-comments.txt‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
FILE: .github/workflows/review-translations.yml
2+
LINE: 8
3+
BODY: The workflow only runs on `pull_request` events `opened` and `synchronize`. If the `action-translation` label is applied after the PR is opened, this workflow will not run, even though the job is gated on that label. Consider adding the `labeled` (and potentially `unlabeled`/`reopened`) event types so labeling a PR triggers the review.
4+
```suggestion
5+
types: [opened, synchronize, labeled, reopened]
6+
```
7+
---
8+
FILE: .github/workflows/review-translations.yml
9+
LINE: 16
10+
BODY: This repo’s other workflows use `actions/checkout@v6` (e.g. `ci.yml`, `cache.yml`, `publish.yml`), but this new workflow uses `actions/checkout@v4`. Aligning on the same major version reduces maintenance overhead and avoids subtle behavioral differences between versions.
11+
```suggestion
12+
- uses: actions/checkout@v6
13+
```
14+
---
15+
FILE: .translate/config.yml
16+
LINE: 4
17+
BODY: PR description says `.translate/config.yml` links to the source repo (`QuantEcon/lecture-python-programming`), but this config file does not include any `source-repo` (or similar) field. If the action-translation tooling expects the source repo to be configured in `.translate/config.yml`, this will cause sync/review runs to be misconfigured; otherwise, the PR description should be updated to match the actual configuration approach.
18+
---
19+
FILE: lectures/jax_intro.md
20+
LINE: 781
21+
BODY: `{doc}` targets typically need to resolve to a local document in this Jupyter Book/Sphinx build. There’s no intersphinx configuration in `lectures/_config.yml` and no local doc named `jax:autodiff`, so this reference is likely to produce an unresolved-reference warning/broken link. Consider restoring the explicit URL, or add/configure the referenced document so the `{doc}` role resolves correctly.
22+
---

‎.tmp/pr66-view.txt‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
author: netlify
2+
association: none
3+
edited: true
4+
status: none
5+
--
6+
### <span aria-hidden="true">✅</span> Deploy Preview for *majestic-griffin-10b166* ready!
7+
8+
9+
| Name | Link |
10+
|:-:|------------------------|
11+
|<span aria-hidden="true">🔨</span> Latest commit | d80d1b2ead9e545c904d0f0d73034d9ed3241f36 |
12+
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/projects/majestic-griffin-10b166/deploys/69bcad4af7d27700086bdc95 |
13+
|<span aria-hidden="true">😎</span> Deploy Preview | [https://deploy-preview-66--majestic-griffin-10b166.netlify.app](https://deploy-preview-66--majestic-griffin-10b166.netlify.app) |
14+
|<span aria-hidden="true">📱</span> Preview on mobile | <details><summary> Toggle QR Code... </summary><br /><br />![QR Code](https://app.netlify.com/qr-code/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJodHRwczovL2RlcGxveS1wcmV2aWV3LTY2LS1tYWplc3RpYy1ncmlmZmluLTEwYjE2Ni5uZXRsaWZ5LmFwcCJ9.dYhqj_6tvYdWQwQoT3B03A0PlgoyqvvL5Bx2Sc0xjpY)<br /><br />_Use your smartphone camera to open QR code link._</details> |
15+
---
16+
<!-- [majestic-griffin-10b166 Preview](https://deploy-preview-66--majestic-griffin-10b166.netlify.app) -->
17+
_To edit notification comments on pull requests, go to your [Netlify project configuration](https://app.netlify.com/projects/majestic-griffin-10b166/configuration/notifications#deploy-notifications)._
18+
--
19+
author: github-actions
20+
association: none
21+
edited: false
22+
status: none
23+
--
24+
<!-- NETLIFY DEPLOY COMMENT GENERATED BY ACTIONS_NETLIFY - APP ID SHA256: c381cf877e46e8dac0fa5e26544c0089e916074eceee08c355a485a14ee833c5 -->
25+
🚀 Deployed on https://69bcae8015ebdf4d7d72b7a8--majestic-griffin-10b166.netlify.app
26+
--
27+
author: copilot-pull-request-reviewer
28+
association: none
29+
edited: false
30+
status: commented
31+
--
32+
## Pull request overview
33+
34+
Sets up the repository to work with QuantEcon’s `action-translation` tooling by adding translation sync state/config, introducing an automated translation-PR review workflow, and updating lecture `heading-map` metadata to the newer key format used for cross-reference syncing.
35+
36+
**Changes:**
37+
- Added `.translate/` configuration and per-lecture sync state files to support incremental sync.
38+
- Added a GitHub Actions workflow to run translation quality review on PRs labeled `action-translation`.
39+
- Updated/added `heading-map` frontmatter in many lecture markdown files (and adjusted one internal reference in `jax_intro.md`).
40+
41+
### Reviewed changes
42+
43+
Copilot reviewed 50 out of 50 changed files in this pull request and generated 4 comments.
44+
45+
<details>
46+
<summary>Show a summary per file</summary>
47+
48+
| File | Description |
49+
| ---- | ----------- |
50+
| .github/workflows/review-translations.yml | New workflow to run `action-translation` review mode on labeled PRs. |
51+
| .translate/config.yml | Adds translation tool config (languages, docs folder, tool version). |
52+
| .translate/state/about_py.md.yml | New sync state tracking for `about_py.md`. |
53+
| .translate/state/debugging.md.yml | New sync state tracking for `debugging.md`. |
54+
| .translate/state/functions.md.yml | New sync state tracking for `functions.md`. |
55+
| .translate/state/getting_started.md.yml | New sync state tracking for `getting_started.md`. |
56+
| .translate/state/intro.md.yml | New sync state tracking for `intro.md`. |
57+
| .translate/state/jax_intro.md.yml | New sync state tracking for `jax_intro.md`. |
58+
| .translate/state/matplotlib.md.yml | New sync state tracking for `matplotlib.md`. |
59+
| .translate/state/names.md.yml | New sync state tracking for `names.md`. |
60+
| .translate/state/need_for_speed.md.yml | New sync state tracking for `need_for_speed.md`. |
61+
| .translate/state/numba.md.yml | New sync state tracking for `numba.md`. |
62+
| .translate/state/numpy.md.yml | New sync state tracking for `numpy.md`. |
63+
| .translate/state/numpy_vs_numba_vs_jax.md.yml | New sync state tracking for `numpy_vs_numba_vs_jax.md`. |
64+
| .translate/state/oop_intro.md.yml | New sync state tracking for `oop_intro.md`. |
65+
| .translate/state/pandas.md.yml | New sync state tracking for `pandas.md`. |
66+
| .translate/state/pandas_panel.md.yml | New sync state tracking for `pandas_panel.md`. |
67+
| .translate/state/python_advanced_features.md.yml | New sync state tracking for `python_advanced_features.md`. |
68+
| .translate/state/python_by_example.md.yml | New sync state tracking for `python_by_example.md`. |
69+
| .translate/state/python_essentials.md.yml | New sync state tracking for `python_essentials.md`. |
70+
| .translate/state/python_oop.md.yml | New sync state tracking for `python_oop.md`. |
71+
| .translate/state/scipy.md.yml | New sync state tracking for `scipy.md`. |
72+
| .translate/state/status.md.yml | New sync state tracking for `status.md`. |
73+
| .translate/state/sympy.md.yml | New sync state tracking for `sympy.md`. |
74+
| .translate/state/troubleshooting.md.yml | New sync state tracking for `troubleshooting.md`. |
75+
| .translate/state/workspace.md.yml | New sync state tracking for `workspace.md`. |
76+
| .translate/state/writing_good_code.md.yml | New sync state tracking for `writing_good_code.md`. |
77+
| lectures/about_py.md | Adds new `heading-map` frontmatter. |
78+
| lectures/debugging.md | Updates `heading-map` keys to new nested heading format. |
79+
| lectures/functions.md | Adds new `heading-map` frontmatter. |
80+
| lectures/getting_started.md | Adds new `heading-map` frontmatter. |
81+
| lectures/jax_intro.md | Updates `heading-map` keys and adjusts an internal autodiff reference. |
82+
| lectures/matplotlib.md | Updates `heading-map` keys to new nested heading format. |
83+
| lectures/names.md | Updates `heading-map` keys to new nested heading format. |
84+
| lectures/need_for_speed.md | Updates `heading-map` keys to new nested heading format. |
85+
| lectures/numba.md | Updates `heading-map` keys to new nested heading format. |
86+
| lectures/numpy.md | Updates `heading-map` keys to new nested heading format. |
87+
| lectures/numpy_vs_numba_vs_jax.md | Updates `heading-map` keys to new nested heading format. |
88+
| lectures/oop_intro.md | Updates `heading-map` keys to new nested heading format. |
89+
| lectures/pandas.md | Updates `heading-map` keys to new nested heading format. |
90+
| lectures/pandas_panel.md | Updates `heading-map` keys to new nested heading format. |
91+
| lectures/python_advanced_features.md | Updates `heading-map` keys to new nested heading format. |
92+
| lectures/python_by_example.md | Adds new `heading-map` frontmatter. |
93+
| lectures/python_essentials.md | Updates `heading-map` keys to new nested heading format. |
94+
| lectures/python_oop.md | Updates `heading-map` keys to new nested heading format. |
95+
| lectures/scipy.md | Adds new `heading-map` frontmatter. |
96+
| lectures/sympy.md | Updates `heading-map` keys to new nested heading format. |
97+
| lectures/troubleshooting.md | Adds new `heading-map` frontmatter. |
98+
| lectures/workspace.md | Updates `heading-map` keys to new nested heading format. |
99+
| lectures/writing_good_code.md | Updates `heading-map` keys to new nested heading format. |
100+
</details>
101+
102+
103+
104+
105+
106+
107+
---
108+
109+
💡 <a href="/QuantEcon/lecture-python-programming.fa/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
110+
--

0 commit comments

Comments
 (0)