search

riboseinc / jekyll-theme-open-project

Jekyll theme for site suite presenting your open software and specifications.
MIT License
30 stars 3 forks source link

`tag_namespaces` generates page filenames like `_site/software/writtenin:Ruby/index.html` which fails in GHA artefact upload #83

Open ronaldtse opened 2 years ago

ronaldtse commented 2 years ago

GHA artifact upload fails at filenames like _site/software/writtenin:Ruby/index.html because the : symbol is not supported, due to NTFS restrictions.

Based on best practice, we should not use filenames with colons.

This issue is described here: https://github.com/actions/upload-artifact/issues/35#issuecomment-574279893

The failing action is located here: https://github.com/metanorma/metanorma.org/runs/5616204145?check_suite_focus=true

strogonoff commented 2 years ago

We use these links, and they work: https://open.ribose.com/software/writtenin:Ruby/

Other sites use them as well: http://en.wikipedia.org/wiki/Template:Welcome

I’m not sure we should change URLs due to artifact-upload behavior and NTFS limitations. Could we avoid uploading intermediate artifacts and just upload the result straight to AWS? It seems that it works (or has worked previously), so is artifact upload not really necessary? If there is a sound reason, perhaps we could just zip the directory and bypass this issue.

strogonoff commented 2 years ago

I will see if this can be worked around with percent-escaped characters in file paths (in the helpers gem), but only if it’s low-effort and straightforward to do with Jekyll.

I re-added the “bug” label back since we do not state that Open Project theme does not support NTFS, so if the above fails at the very least docs would be updated.

ronaldtse commented 2 years ago

I've temporarily worked around this by pre-zipping the file before GHA artifact upload and manually unzipping it after: https://github.com/metanorma/metanorma.org/commit/0d623b4b3186c484073d785c2757cf0bfe3dfef2