Glossary generator with apa lookup by kaysiz · Pull Request #595 · forrtproject/forrtproject.github.io

kaysiz · 2026-01-26T08:56:03Z

Description

Fixes # (issue)

Type of Change

Documentation/Contents/grammar update
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Tested Locally
Manual review / previewed on staging.forrt.org content/webpage changes
Not Tested yet

Checklist for Content Editors and Non-Developers

The content is clear, accurate, and follows community guidelines.
All updated content has been previewed on the staging site.
All links, references, and formatting have been checked for correctness.
The change aligns with the overall style and communication goals.
No broken links in text/content

Checklist for Developers:

I have attempted to stay aligned to related code in this repository rather than reinventing the wheel.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.

Additional Notes

github-actions · 2026-01-26T08:56:23Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-01-26T08:56:29Z

👍 All image files/references (if any) are in webp format, in line with our policy.

github-actions · 2026-01-27T12:31:28Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

Copilot

Pull request overview

Adds an APA-reference lookup workflow and updates glossary generation to use it when producing glossary entry files.

Changes:

Added content/glossary/apa_lookup.json as a citation-key → APA-formatted reference lookup.
Refactored content/glossary/_create_glossaries.py to pull glossary data from a Google Sheets CSV export and format references via the APA lookup.
Added a Node.js utility (bibtex_to_apa/) and CI workflow steps to generate/update the APA lookup during data processing.

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
content/glossary/apa_lookup.json	New citation-key → APA reference mapping used during glossary generation.
content/glossary/_create_glossaries.py	New glossary generation pipeline that reads a sheet export and formats references using the APA lookup.
bibtex_to_apa/package.json	Adds dependencies for converting BibTeX to APA via citation-js.
bibtex_to_apa/package-lock.json	Lockfile for the bibtex→APA conversion tool dependencies.
bibtex_to_apa/bibtex_to_apa.js	Node script to fetch BibTeX and emit `apa_lookup.json`.
.github/workflows/data-processing.yml	Installs Node deps and runs the bibtex→APA generation step in CI.

Files not reviewed (1)

bibtex_to_apa/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-28T22:09:18Z

bibtex_to_apa/bibtex_to_apa.js

+      console.log(`Usage: node bibtex-to-apa.js [-i INPUT] [-o OUTPUT] [--no-url]
+Options:
+  -i, --input   Input BibTeX (URL or file). Default: Google Doc
+  -o, --output  Output JSON file. Default: apa_lookup.json
+  --no-url      Don't append URLs to references`);


The help/usage text references node bibtex-to-apa.js, but the actual script filename in this repo is bibtex_to_apa.js. This mismatch makes the CLI guidance incorrect; update the usage string (or rename the script to match the documented name).

Copilot · 2026-01-28T22:09:19Z

content/glossary/_create_glossaries.py

+
+# Load APA lookup
+try:
+    with open('apa_lookup.json', 'r') as f:


apa_lookup.json is opened via a relative path, so running this script from the repo root (as the workflow does with python3 content/glossary/_create_glossaries.py) will not find the file and references won’t be formatted. Use os.path.join(script_dir, 'apa_lookup.json') (and consider specifying encoding='utf-8').

Suggested change

with open('apa_lookup.json', 'r') as f:

with open(os.path.join(script_dir, 'apa_lookup.json'), 'r', encoding='utf-8') as f:

Copilot · 2026-01-28T22:09:19Z

.github/workflows/data-processing.yml

+        with:
+          node-version: '18'
+          cache: 'npm'
+


actions/setup-node caching is configured with cache: 'npm' but without cache-dependency-path, so it will default to a root package-lock.json and likely miss caching for bibtex_to_apa/. Set cache-dependency-path: bibtex_to_apa/package-lock.json (and include any other lockfiles you want cached).

Suggested change

cache-dependency-path: bibtex_to_apa/package-lock.json

Copilot · 2026-01-28T22:09:19Z

.github/workflows/data-processing.yml

+        continue-on-error: true  # Continue even if this step fails
+        run: |
+          cd bibtex_to_apa
+          node bibtex-to-apa.js -o '../content/glossary/apa_lookup.json'


This step calls node bibtex-to-apa.js, but the committed script file is bibtex_to_apa/bibtex_to_apa.js. As written, the command will fail (and then be silently ignored due to continue-on-error). Update the command to use the correct filename (or rename the script to match).

Suggested change

node bibtex-to-apa.js -o '../content/glossary/apa_lookup.json'

node bibtex_to_apa.js -o '../content/glossary/apa_lookup.json'

Copilot · 2026-01-28T22:09:20Z

content/glossary/_create_glossaries.py

+        if column in row.index and pd.notna(row[column]):
+            return str(row[column]).strip()
+        return default
+    except:


Except block directly handles BaseException.

Suggested change

except:

except Exception:

…ect/forrtproject.github.io into ks-refactor-glossary-generator

github-actions · 2026-01-29T13:32:45Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-01-29T13:32:57Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-02-05T04:59:14Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

github-actions · 2026-02-05T15:05:06Z

✅ Spell Check Passed

No spelling issues found in this PR! 🎉

kaysiz added 4 commits January 25, 2026 22:21

Add bibtex apa json generator

f6757ef

Initial apa look up file

df39d64

refactor translation markdown generation code

f3eb0a5

update workflow to add new flow to generate glossary

6f711b3

github-actions bot added content related Relevant to website content cicd Relevant to GitHub workflows labels Jan 26, 2026

kaysiz requested a review from LukasWallrich January 27, 2026 08:47

kaysiz self-assigned this Jan 27, 2026

Merge branch 'master' into ks-refactor-glossary-generator

266adb2

LukasWallrich requested a review from Copilot January 28, 2026 22:05

Copilot started reviewing on behalf of LukasWallrich January 28, 2026 22:05 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

kaysiz and others added 4 commits January 29, 2026 14:25

Address review comments

5c291b3

Update gitignore

dc80c3c

Merge branch 'ks-refactor-glossary-generator' of github.com:forrtproj…

43aef0c

…ect/forrtproject.github.io into ks-refactor-glossary-generator

Merge branch 'master' into ks-refactor-glossary-generator

90edaf1

Implement missing reference tracking

fded9da

Merge branch 'master' into ks-refactor-glossary-generator

a5a4029

	with open('apa_lookup.json', 'r') as f:
	with open(os.path.join(script_dir, 'apa_lookup.json'), 'r', encoding='utf-8') as f:

	node bibtex-to-apa.js -o '../content/glossary/apa_lookup.json'
	node bibtex_to_apa.js -o '../content/glossary/apa_lookup.json'

Conversation

kaysiz commented Jan 26, 2026

Description

Type of Change

How Has This Been Tested?

Checklist for Content Editors and Non-Developers

Checklist for Developers:

Additional Notes

Uh oh!

github-actions bot commented Jan 26, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Jan 26, 2026

Uh oh!

github-actions bot commented Jan 27, 2026

✅ Spell Check Passed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 29, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Jan 29, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 5, 2026

✅ Spell Check Passed

Uh oh!

github-actions bot commented Feb 5, 2026

✅ Spell Check Passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant