Automate jobs board with schema validation by shibo911 · Pull Request #360 · pybamm-team/pybamm.org

shibo911 · 2025-12-22T18:28:45Z

Fixes #352

Summary

Jobs board is generated from YAML files under data/jobs/ using a shortcode + partials.
Open roles vs Archived roles split based on expires date; archived retained and collapsed by default.
Sorting: Open by deadline asc; Archived by expires desc.
Job YAML validation enforced via pre-commit using check-jsonschema + data/jobs/schema.json.
Styling uses theme variables with minimal overrides.

How to test

pre-commit run --all-files
hugo server -D and visit /jobs/

netlify · 2025-12-22T18:28:50Z

✅ Deploy Preview for pybamm-developer-preview ready!

Name	Link
🔨 Latest commit	`96237a1`
🔍 Latest deploy log	https://app.netlify.com/projects/pybamm-developer-preview/deploys/6950fe011cabbb000884c486
😎 Deploy Preview	https://deploy-preview-360--pybamm-developer-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 Accessibility: 100 Best Practices: 92 SEO: 91 PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

agriyakhetarpal · 2025-12-23T05:19:19Z

Thanks, @shibo911! Could you please investigate the build failure?

agriyakhetarpal · 2025-12-23T05:21:35Z

BTW, you may use nox to build the entire site instead of hugo server – that'll generate the pagefind search, too.

shibo911 · 2025-12-24T08:06:38Z

BTW, you may use nox to build the entire site instead of hugo server – that'll generate the pagefind search, too.

thanks, i will try to fix the pr

…YAML via schema without unsupported flag\n- hugo: suppress legacy GetJSON error from theme (ignoreLogs)\n- css: robust badge spacing and layout for jobs cards\n- jobs: use transform.Unmarshal for YAML loading (no GetJSON)

shibo911 · 2025-12-24T09:05:59Z

@agriyakhetarpal

Update: Build fixed; preview ready.

Fixes

Jobs data loader uses readFile + transform.Unmarshal for YAML (no legacy GetJSON). Only data/jobs/*.yaml are loaded; schema/template are ignored.
Suppressed unrelated legacy theme GetJSON error via ignoreLogs to prevent build aborts.
Pre-commit schema validation wired correctly (check-jsonschema with data/jobs/schema.json); pre-commit.ci passes.
Hardened jobs badge styling so “pill” spacing is consistent across environments.

Verification

pre-commit run --all-files: passed locally and on pre-commit.ci.
Netlify build: uses nox (hugo → pagefind) and passes.
Deploy Preview: https://deploy-preview-360--pybamm-developer-preview.netlify.app/jobs/

Notes

Open vs Archived split and sorting work as specified; Archived collapsed by default.
Styling follows theme variables with minimal overrides.

Ready for review.

agriyakhetarpal

Hi @shibo911, this is a good start! There is a lot of code here and while the output looks good on the deploy preview, there are a few things to consider – please see my comments below.

Also, for an individual job, I think we should use the card shortcode to include the data, and for the fields such "100% time", "Remote", etc., these should be included as badges.

My main concern is the use of AI-written code in this PR, which is generally okay as long as the code is good, but right now there are many existing patterns in the theme that the language model you've used has not accounted for. It is necessary to implement this carefully, as there is a maintenance burden attached to this new code and we'd like it if this code were to not break over the course of the many years that this website will be maintained for.

agriyakhetarpal · 2025-12-27T15:03:23Z

config.yaml

+# Suppress legacy GetJSON errors originating from theme code
+ignoreLogs:
+  - error-remote-getjson
+


Where is the GetJSON error coming from the theme code? Could you please elaborate? I don't see anything here: https://github.com/search?q=repo:scientific-python/scientific-python-hugo-theme+GetJSON&type=code

addressed, I added that line to test my pr locally. I think there must have been some issue while building the server thats why i added those line, I should have restored some files while pushing git but that's a terrible mistake on my end.

agriyakhetarpal · 2025-12-27T15:03:48Z

.pre-commit-config.yaml

    -   id: ruff
        args: ["--fix", "--show-fixes"]

+# Jobs board validation (schema-based)


Suggested change

# Jobs board validation (schema-based)

The code is self-explanatory, so this doesn't need a comment

agriyakhetarpal · 2025-12-27T15:04:24Z

.pre-commit-config.yaml


+# Jobs board validation (schema-based)
+-   repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.33.3


Suggested change

rev: 0.33.3

rev: 0.36.0

Is there a reason for using 0.33.3 instead of the latest release available? https://github.com/python-jsonschema/check-jsonschema

addressed, used the latest version

agriyakhetarpal · 2025-12-27T15:05:22Z

layouts/partials/jobs/list.html

+{{/*
+Load only YAML postings from data/jobs/*.yaml.
+Avoid reading data/jobs/schema.json (used only for validation).
+*/}}


This should be cleaned up; it is easy to understand that the file is used only for validation is redundant for the partial.

understood and addressed

agriyakhetarpal · 2025-12-27T15:08:39Z

layouts/partials/jobs/list.html

+{{- range (readDir "data/jobs") -}}
+  {{- if and (not .IsDir) (hasSuffix .Name ".yaml") (ne .Name "_TEMPLATE.yaml") -}}
+    {{- $path := printf "data/jobs/%s" .Name -}}
+    {{- $data := (readFile $path | transform.Unmarshal) -}}
+    {{- $key := replaceRE "\\.yaml$" "" .Name -}}
+    {{- $job := dict "key" $key | merge $data -}}
+    {{- $jobs = $jobs | append $job -}}
+  {{- end -}}
+{{- end -}}
+
+{{/* partition */}}
+{{- $open := slice -}}
+{{- $archived := slice -}}
+{{- range $jobs -}}
+  {{- $exp := .expires -}}
+  {{- if or (not $exp) (ge (time $exp) $now) -}}
+    {{- $open = $open | append . -}}
+  {{- else -}}
+    {{- $archived = $archived | append . -}}
+  {{- end -}}
+{{- end -}}


I think this can be simplified – see https://stackoverflow.com/a/33233395 for an example?

addressed. refactored the layouts/partials/jobs/list.html to simplify data loading using hugo’s built-in data mechanism, per the review suggestion

agriyakhetarpal · 2025-12-27T15:11:16Z

content/jobs.md

+1. Open a pull request adding a YAML file at data/jobs/ following data/jobs/_TEMPLATE.yaml.
+2. Ensure dates are in YYYY-MM-DD and include a working https:// or http:// URL.
+3. Optionally, also [email us](mailto:pybamm@pybamm.org) for visibility.
+4. If applicable, make a payment or donation as per our policy.


Marking this comment as we'll need to get some confirmation on the proposed flow for this. @brosaplanella would be the best person to answer this, since he opened #352.

addressed, added a neutral line just stating the submission instructions, about opening a PR through template.

agriyakhetarpal · 2025-12-27T15:11:49Z

content/jobs.md

 ---

-Welcome to the PyBaMM Jobs Board! Here you can find current job openings related to PyBaMM and battery modeling. If you're interested in contributing to the future of battery simulation and modeling, check out the opportunities below.
+Welcome to the PyBaMM Jobs Board! This page is generated from simple YAML files under data/jobs/.


Let's bring back the previous sentence here

agriyakhetarpal · 2025-12-27T15:15:27Z

assets/css/overrides.css

It looks like the code in this file was generated with AI. While we are okay with the use of AI-written code, we consider it your responsibility to thoroughly review it and address any potential mistakes. Could you please remove the comments indicative of AI and remove the redundant CSS rules from here?

Also, these styles will apply to the entire website, so we must ensure that they affect only the jobs page.

addressed and applied the requested clean up and scoping
scoped jobs styles to jobs page and removed ai indicative and verbose comments, also avoided unnecessary global impact, now job related rules are isolated under .jobs-board

agriyakhetarpal · 2025-12-27T15:16:12Z

assets/css/overrides.css

+  .markdown .adm, .markdown .adm * {
+    color: var(--text, #f1f5f9) !important;
+  }
+  .adm a { color: var(--primary, #9ae6b4) !important; }
+  /* Provide a gentle dark surface without hardcoding brand colors */
+  .adm { background: var(--surface-2, rgba(255,255,255,0.06)) !important; }
+}


Instead of !importants, we should address any dark theme problem upstream with the theme itself – I would advise against using them unless they're really needed

addressed, removed !important and used selector specificity as advised

agriyakhetarpal · 2025-12-27T15:20:44Z

layouts/partials/jobs/list.html

+<details>
+  <summary><h2 id="archived-roles" style="display:inline">Archived roles</h2></summary>
+  {{- $sortedArchived := sort $archived "expires" "desc" -}}
+  {{- if gt (len $sortedArchived) 0 -}}
+    {{- range $sortedArchived -}}
+      {{ partial "jobs/card.html" (dict "job" . "now" $now) }}
+    {{- end -}}
+  {{- else -}}
+    <p>No archived roles yet.</p>
+  {{- end -}}
+</details>


This should use the theme's details shortcode instead of inline HTML code.

addressed, removed the raw HTML and used the theme's detail shortcode

shibo911 · 2025-12-28T08:08:51Z

I will work on the comments. Thank you for the thorough review!

…ump schema validator

…when .Site.Data is empty

…e robust across builds)

Automate jobs board with schema validation

937757a

shibo911 added 4 commits December 23, 2025 00:06

Fix jobs board: exclude template from rendering

b941db1

Debug jobs board: show source key

bf8c2c5

Fix jobs board: load only YAML postings (ignore schema/template)

d6f7765

Add example job posting for preview

c6f022f

agriyakhetarpal requested changes Dec 27, 2025

View reviewed changes

shibo911 added 5 commits December 28, 2025 14:16

jobs: align with theme shortcodes, scope styles, simplify copy, and b…

3e6b9d6

…ump schema validator

jobs: use www.ionworks.com for reliability

5859815

jobs: add human-readable job posting template (_TEMPLATE.yaml)

542e662

jobs: ensure jobs render by falling back to reading data/jobs/*.yaml …

2d0361c

…when .Site.Data is empty

jobs: simplify data loading by reading data/jobs/*.yaml directly (mor…

96237a1

…e robust across builds)

Uh oh!

Conversation

shibo911 commented Dec 22, 2025

Summary

How to test

Uh oh!

netlify bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for pybamm-developer-preview ready!

Uh oh!

agriyakhetarpal commented Dec 23, 2025

Uh oh!

agriyakhetarpal commented Dec 23, 2025

Uh oh!

shibo911 commented Dec 24, 2025

Uh oh!

shibo911 commented Dec 24, 2025

Uh oh!

agriyakhetarpal left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shibo911 commented Dec 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Dec 22, 2025 •

edited

Loading

agriyakhetarpal left a comment •

edited

Loading