Skip to content

Gitlab pages fails, because automatically generated API produces too long name.

Summary

See this output of the pipeline: https://gitlab.indiscale.com/caosdb/src/caosdb-webui/-/jobs/99921

$ make doc
make -C src/doc html
make[1]: Entering directory '/builds/ybudqsep/0/caosdb/src/caosdb-webui/src/doc'
PATH=/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/.bin:$PATH jsdoc -t /builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc-sphinx/template -d api -r "../../src/core"
internal/fs/utils.js:332
    throw err;
    ^
Error: ENAMETOOLONG: name too long, open 'api/caosdb_default_person_reference%0A%0AReplace%20the%20reference%20to%20a%20Person%20Record%20by%20the%20values%20of%20that%0ARecord_s%20firstname%20and%20lastname%20properties.%0A%0ATODO_%20Make%20name(s)%20of%20person%20RecordType(s)%20and%20names%20of%20firstname%0Aand%20lastname%20properties%20configurable.module_.rst'
    at Object.openSync (fs.js:497:3)
    at Object.writeFileSync (fs.js:1528:35)
    at /builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc-sphinx/template/publish.js:172:8
    at /builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc-sphinx/template/publish.js:189:15
    at /builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc-sphinx/node_modules/mkdirp/index.js:51:26
    at FSReqCallback.oncomplete (fs.js:192:5)
    at Function.module.exports.loopWhile (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/deasync/index.js:71:23)
    at /builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/deasync/index.js:41:18
    at Object.publish (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc-sphinx/template/publish.js:113:5)
    at Object.module.exports.cli.generateDocs (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc/cli.js:441:39)
    at Object.module.exports.cli.processParseResults (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc/cli.js:392:24)
    at module.exports.cli.main (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc/cli.js:235:18)
    at Object.module.exports.cli.runCommand (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc/cli.js:186:9)
    at /builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc/jsdoc.js:93:9
    at Object.<anonymous> (/builds/ybudqsep/0/caosdb/src/caosdb-webui/node_modules/jsdoc/jsdoc.js:94:3)
    at Module._compile (internal/modules/cjs/loader.js:1085:14) {
  errno: -36,
  syscall: 'open',
  code: 'ENAMETOOLONG',
  path: 'api/caosdb_default_person_reference%0A%0AReplace%20the%20reference%20to%20a%20Person%20Record%20by%20the%20values%20of%20that%0ARecord_s%20firstname%20and%20lastname%20properties.%0A%0ATODO_%20Make%20name(s)%20of%20person%20RecordType(s)%20and%20names%20of%20firstname%0Aand%20lastname%20properties%20configurable.module_.rst'
}

Expected Behavior

Pipeline should run through.

Actual Behavior

Pipeline fails.

Steps to Reproduce the Problem

Push to the main branch.

Possible fixes

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information