documenation-generator webhook action thing

kastle-lab / modular-ontology-design-library

Creative Commons Attribution Share Alike 4.0 International

2 stars 1 forks source link

Closed cogan-shimizu closed 1 year ago

cogan-shimizu commented 1 year ago

[x] GitHub/git submodules (can we just embed documentation generator in the modl and hook it from there?)
[x] Get it working
[ ] Get it working also generating a .md file with the same contents in the same folder (at least for the pattern files)

JoshQuaintance commented 1 year ago

Using the git pre-commit hook, it will now check if a .owl file has been staged for commit and before it is commited, the hook will run the documentation-generator.
Right now the script will fetch for the script every single run, but if we decided to use submodules, it will just use the submodule.
The conversion to markdown somewhat works with pandoc, but it cannot convert the LaTeX math. GitHub does read and parse the LaTeX math and display properly in GitHub

threefinbdd commented 1 year ago

This is more for record keeping with CI/CD on modl:

Notes running pre-commit hook:

Requires env folder for #!/env/bash - easy change for local systems IE., #!/usr/bin/bash. I don't think theres much that can be done about this other than document it if git commit complains about "No such file or directory".
Probably the biggest issue is the hook script acts up with bad invisible characters. The quick-fix here is dos2unix on the script itself to remove the bad characters. Saucey

cogan-shimizu commented 1 year ago

Is it a windows line ending thing?