Skip to content

Improving build dev/releases/latest release #8

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
agbeltran merged 2 commits into from
Feb 22, 2026
Merged

Improving build dev/releases/latest release #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cac2e49
Rename onto_syntax_doc.py to ontology_build.py and update actions
agbeltran Feb 22, 2026
8810bdd
Dynamically adjust build location and index title based on branch
agbeltran Feb 22, 2026
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
12 changes: 7 additions & 5 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,10 @@ jobs:
needs: check-version
runs-on: ubuntu-latest
env:
DEV_DIR: ${{ github.ref_name == 'main' && './public' || './public/dev' }}
BUILD_DIR: ${{ github.ref_name == 'main' && './public' || './public/dev' }}
RELEASE_VERSION: ${{ needs.check-version.outputs.is_new == 'true' && needs.check-version.outputs.version || '' }}
IS_MAIN: ${{ github.ref_name == 'main' && 'true' || 'false' }}
CURRENT_VERSION: ${{ needs.check-version.outputs.version }}
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down Expand Up @@ -117,11 +119,11 @@ jobs:

- name: Generate ontology syntaxes and documentation
run: |
python3 src/scripts/onto_syntax_doc.py
python3 src/scripts/ontology_build.py

- name: Upload dev artifact
# if DEV_DIR is set to something non-empty, we upload the whole public struct
if: ${{ env.DEV_DIR != '' && env.DEV_DIR != null }}
- name: Upload root artifact
# if BUILD_DIR is set to something non-empty, we upload the whole public struct
if: ${{ env.BUILD_DIR != '' && env.BUILD_DIR != null }}
uses: actions/upload-artifact@v4
with:
name: site
Expand Down
39 changes: 26 additions & 13 deletions src/scripts/onto_syntax_doc.py → src/scripts/ontology_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
RELEASES_DIR = os.environ['RELEASES_DIR']

RELEASE_VERSION = os.environ.get('RELEASE_VERSION')
DEV_DIR = os.environ.get('DEV_DIR')
BUILD_DIR = os.environ.get('BUILD_DIR')
IS_MAIN = os.environ.get('IS_MAIN') == 'true'
CURRENT_VERSION = os.environ.get('CURRENT_VERSION', '')

g = Graph()
g.parse(os.path.join(ONTO_DIR, ONTO_FILE))
Expand Down Expand Up @@ -102,21 +104,32 @@ def generate_widoco_docs(outdir, onto_dir, onto_file, version="1.4.25"):
f.write(f'<li><a href="{r}/">{r}</a></li>\n')
f.write("</ul>\n</body></html>\n")

if DEV_DIR:
# --- development build ---
generate_syntaxes(DEV_DIR)
if BUILD_DIR:
# --- base build ---
generate_syntaxes(BUILD_DIR)

dev_docs_dir = os.path.join(DEV_DIR, "docs")
generate_pylode_docs(dev_docs_dir)
generate_widoco_docs(dev_docs_dir, ONTO_DIR, ONTO_FILE)
build_docs_dir = os.path.join(BUILD_DIR, "docs")
generate_pylode_docs(build_docs_dir)
generate_widoco_docs(build_docs_dir, ONTO_DIR, ONTO_FILE)

# Generate dev index.html
dev_index = os.path.join(DEV_DIR, 'index.html')
with open(dev_index, 'w') as f:
f.write("<html><head><title>FUEL Development Build</title></head><body>\n")
f.write("<h1>FUEL Ontology (Development)</h1>\n<ul>\n")
# Generate build index.html
build_index = os.path.join(BUILD_DIR, 'index.html')
with open(build_index, 'w') as f:
if IS_MAIN:
title = f"FUEL Ontology (v{CURRENT_VERSION})" if CURRENT_VERSION else "FUEL Ontology"
heading = f"FUEL Ontology (Latest Release v{CURRENT_VERSION})" if CURRENT_VERSION else "FUEL Ontology (Latest Release)"
else:
title = "FUEL Development Build"
heading = "FUEL Ontology (Development Build)"

f.write(f"<html><head><title>{title}</title></head><body>\n")
f.write(f"<h1>{heading}</h1>\n<ul>\n")
f.write('<li><a href="docs/pylode/">Pylode Documentation</a></li>\n')
f.write('<li><a href="docs/widoco/">Widoco Documentation</a></li>\n')
for ext, fmt in target_fmts:
f.write(f'<li><a href="{ONTO_ABBREV}.{ext}">{ONTO_ABBREV}.{ext}</a></li>\n')
f.write("</ul>\n</body></html>\n")
f.write("</ul>\n")
if IS_MAIN:
f.write('<h2><a href="releases/">Previous Releases</a></h2>\n')
f.write('<h2><a href="dev/">Development Build</a></h2>\n')
f.write("</body></html>\n")