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.

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

JSDOC_ERROR: There are no input files to process (jsdoc fails when there's an underscore in the path ) #308

Open
whoisflo opened this issue Dec 17, 2024 · 4 comments
Labels

Comments

@whoisflo
Copy link

Hi there,

I'm encountering an issue while trying to generate documentation for my project using the jsdoc2md functionality within GitHub Actions. My goal is to automate the documentation build process.

Use Case: I want to create a new .md file using the command jsdoc2md utilities.js > utilities.md in my build script. However, I'm facing the following error:

JSDOC_ERROR: There are no input files to process.
This error occurs despite the utilities.js file being present. Interestingly, the command works perfectly when run locally in the terminal.

Heres an additional screenshot of the steps:
Screenshot 2024-12-17 at 8 19 38 AM

Could you please help me identify what might be causing this issue?

Thank you!

@75lb
Copy link
Member

75lb commented Dec 17, 2024

Screenshot 2024-12-17 at 13 53 52

See this jsdoc issue.

This "underscore" issue was fixed in jsdoc-api v9.1.0. If you upgrade jsdoc-to-markdown to the latest version, it should resolve your issue. Let me know if not.

@whoisflo
Copy link
Author

whoisflo commented Dec 17, 2024

Hey @75lb,

Thanks for your response! I've been using the latest version 9.1.1 and it's still giving me the issue. Should I try the specific 9.1.0 version?

@75lb 75lb changed the title JSDOC_ERROR: There are no input files to process. JSDOC_ERROR: There are no input files to process (jsdoc fails when there's an underscore in the path ) Dec 17, 2024
@75lb 75lb added the upstream label Dec 17, 2024
@75lb
Copy link
Member

75lb commented Dec 17, 2024

No, you're using the correct version. I double-checked and the jsdoc-api fix I mentioned previously only works around the "jsdoc underscore" bug in the cache directory path. Unfortunately, it's still an issue if the current working directory contains an underscore anywhere in the path.

I'm guessing you have no control over the Github Actions path name, so for now, here's a workaround suggestion.

@whoisflo
Copy link
Author

Thanks for looking into it! I will try the workaround, since I am not able to change the GitHub runners path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants