Skip to content
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

Jump to bottom

4.2.15 breaks building docs #259

Closed
linusha opened this issue Nov 7, 2023 · 4 comments · Fixed by #260
Closed

4.2.15 breaks building docs #259

linusha opened this issue Nov 7, 2023 · 4 comments · Fixed by #260

Comments

@linusha
Copy link

linusha commented Nov 7, 2023

Describe the bug

Since today, so with the release of 4.2.15 our pipeline building our docs fails. The only change comes due to us using the newest version of this package, as we had not pinned it earlier. Using 4.2.14 resolved our problem.

This problem occurs in a GitHub Actions hosted runner on linux. A failing run can be found here.

The following error occurs:

undefined:13
for (const script of this.includeScript) {
                          ^

TypeError: this.includeScript is not iterable
    at Template.eval (eval at template (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/node_modules/underscore/underscore-node-f.cjs:924:14), <anonymous>:13:27)
    at Template.template (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/node_modules/underscore/underscore-node-f.cjs:931:19)
    at Template.partial (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/lib/jsdoc/template.js:55:33)
    at Template.eval (eval at template (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/node_modules/underscore/underscore-node-f.cjs:924:14), <anonymous>:288:14)
    at Template.template (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/node_modules/underscore/underscore-node-f.cjs:931:19)
    at Template.partial (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/lib/jsdoc/template.js:55:33)
    at Template.render (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/lib/jsdoc/template.js:69:28)
    at generate (/home/runner/work/lively.next/lively.next/node_modules/clean-jsdoc-theme/publish.js:332:17)
    at /home/runner/work/lively.next/lively.next/node_modules/clean-jsdoc-theme/publish.js:369:9
    at Array.forEach (<anonymous>)
    at generateSourceFiles (/home/runner/work/lively.next/lively.next/node_modules/clean-jsdoc-theme/publish.js:344:30)
    at exports.publish (/home/runner/work/lively.next/lively.next/node_modules/clean-jsdoc-theme/publish.js:917:9)
    at module.exports.cli.generateDocs (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/cli.js:441:39)
    at module.exports.cli.processParseResults (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/cli.js:392:24)
    at module.exports.cli.main (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/cli.js:235:18)
    at module.exports.cli.runCommand (/opt/hostedtoolcache/node/18.12.1/x64/lib/node_modules/jsdoc/cli.js:186:9)
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 7, 2023

Wonderful, you have created your first issue for clean-jsdoc-theme. Someone will talk to you soon!

@gdelacampa
Copy link

Beat me to it am getting this same issue as well. Rolled back to 4.2.12 in package.json and it started working again.

@ankitskvmdam
Copy link
Owner

Thanks @linusha and @gdelacampa for reporting this bug.
Working on this Bug,

ankitskvmdam added a commit that referenced this issue Nov 7, 2023
@ankitskvmdam
fix: v4.2.15 breaks building docs
4e36c95 
In v4.2.15 we have added a feature to include scripts and styles only in
target files. In order to do so we are looping through `this.includeScript`
and `this.includeCss`. However we are not checking whether these are
defined.

So, for users who don't want to include any script/style above mentioned
variables are undefined for then, hence cause the build to fail because
undefined is not iterable.

This PR fixes this issue, as now we are checking whether these variables
are defined.

fixes: #259
@ankitskvmdam ankitskvmdam mentioned this issue Nov 7, 2023
Merged
@ankitskvmdam
Copy link
Owner

I have published v4.2.16, it will fix the build issue. 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: v4.2.15 breaks building docs ankitskvmdam/clean-jsdoc-theme
3 participants
@linusha @ankitskvmdam @gdelacampa