Skip to content

Fix #10: Make the railroad grammar diagram part of the hourly build process for the website #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lefticus merged 1 commit into from
Apr 14, 2026
Merged

Fix #10: Make the railroad grammar diagram part of the hourly build process for the website #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/workflows/update-grammar.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Update Grammar Railroad Diagram

on:
schedule:
- cron: '47 * * * *'
workflow_dispatch:

permissions:
contents: write

jobs:
update-grammar:
name: Generate railroad diagram from EBNF grammar
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '17'

- name: Download EBNF grammar
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
mkdir -p grammar
gh api repos/ChaiScript/ChaiScript/contents/grammar/chaiscript.ebnf \
--jq '.content' | base64 -d > grammar/chaiscript.ebnf

- name: Download rr-webapp
run: |
curl -sL \
"https://repo1.maven.org/maven2/de/bottlecaps/rr/rr-webapp/2.6/rr-webapp-2.6.war" \
-o /tmp/rr.war

- name: Generate railroad diagram
run: |
java -jar /tmp/rr.war \
-out:grammar/railroad.xhtml \
grammar/chaiscript.ebnf

- name: Check for changes
id: changes
run: |
git add grammar/
if git diff --cached --quiet; then
echo "changed=false" >> "$GITHUB_OUTPUT"
else
echo "changed=true" >> "$GITHUB_OUTPUT"
fi

- name: Commit and push
if: steps.changes.outputs.changed == 'true'
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git commit -m "Update grammar railroad diagram from ChaiScript/ChaiScript"
git push
3 changes: 3 additions & 0 deletions _includes/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
<li>
<a href="https://github.com/ChaiScript/ChaiScript/blob/develop/cheatsheet.md">Cheatsheet</a>
</li>
<li {% if page.url == '/grammar.html'%} class='active' {% endif %}>
<a href="/grammar.html">Grammar</a>
</li>
<li {% if page.url == '/docs.html'%} class='active' {% endif %}>
<a href="/docs.html">Docs</a>
</li>
Expand Down
50 changes: 50 additions & 0 deletions grammar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Grammar
---

<!DOCTYPE HTML>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />

<head>
<title>ChaiScript - Grammar Railroad Diagram</title>
{% include common.html %}

<style>
.grammar-iframe {
width: 100%;
min-height: 800px;
border: 1px solid #ddd;
border-radius: 4px;
background: #fff;
}
.grammar-links {
margin-top: 10px;
font-size: 0.9rem;
}
</style>

</head>

<body>

{% include header.html %}

<div class="well well-sm">
<h3>Grammar Railroad Diagram</h3>
<p>Navigable railroad diagram of ChaiScript's syntax, generated from the
<a href="https://github.com/ChaiScript/ChaiScript/blob/develop/grammar/chaiscript.ebnf">EBNF grammar</a>
using <a href="https://github.com/GuntherRademacher/rr">RR</a>.</p>
</div>

<div class="body-with-margin">
<iframe class="grammar-iframe" src="/grammar/railroad.xhtml" title="ChaiScript grammar railroad diagram"></iframe>

<div class="grammar-links">
<p>
<a href="/grammar/railroad.xhtml">Open full-page diagram</a> &middot;
<a href="/grammar/chaiscript.ebnf">Download EBNF source</a>
</p>
</div>
</div>

</body>
18 changes: 17 additions & 1 deletion test_playground.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Regression test for issue #6: WASM playground
# Regression tests for the ChaiScript website build artifacts.
# Validates that all required files exist and contain expected content.
set -euo pipefail

Expand Down Expand Up @@ -40,6 +40,22 @@ assert_file_contains "playground.html" "header.html"
# 3. Navigation includes playground link
assert_file_contains "_includes/header.html" "playground"

# 4. Grammar railroad diagram workflow exists and runs hourly
assert_file_exists ".github/workflows/update-grammar.yml"
assert_file_contains ".github/workflows/update-grammar.yml" "schedule"
assert_file_contains ".github/workflows/update-grammar.yml" "cron:"
assert_file_contains ".github/workflows/update-grammar.yml" "chaiscript.ebnf"
assert_file_contains ".github/workflows/update-grammar.yml" "ChaiScript/ChaiScript"
assert_file_contains ".github/workflows/update-grammar.yml" "rr-webapp"

# 5. Grammar page exists with required elements
assert_file_exists "grammar.html"
assert_file_contains "grammar.html" "header.html"
assert_file_contains "grammar.html" "railroad"

# 6. Navigation includes grammar link
assert_file_contains "_includes/header.html" "grammar"

if [ "$FAIL" -ne 0 ]; then
echo ""
echo "RESULT: SOME TESTS FAILED"
Expand Down