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

Unable to generate documentation using github actions #27

Open
SushiWaUmai opened this issue Jul 24, 2023 · 2 comments
Open

Unable to generate documentation using github actions #27

SushiWaUmai opened this issue Jul 24, 2023 · 2 comments

Comments

@SushiWaUmai
Copy link

I have a problem where I want to generate documentation, using github actions where the .csproj files are not available. Is it possible to generate the documentation without the .csproj files? Or could you generate the .csproj files on the fly inside the action itself?

@NormandErwan
Copy link
Owner

NormandErwan commented Jul 24, 2023

It's not ideal, but I commit the .csproj to the repo.

I need to update the Readme with this info, it's missing. Thank you for the issue!

You could also generate the documentation using just the .cs files (to config in the docfx.json > metadata section). But the generation was not good, although I can't remember why.

When I made the repo a few years back, I didn't find a solution to generate the .csproj files on the fly, as GitHub actions were quite new. But I think a lot of effort has been done with GameCI. It should be possible now.

Or an alternative should be to commit a very simple .NET .csproj in the Documentation/ folder. I will give it a try.

@kushG
Copy link

kushG commented Mar 15, 2024

If you are working with Rider you can call Packages.Rider.Editor.RiderScriptEditor.SyncSolution this method from your CI job. There might be something similar for Visual Studio if you don't have Rider

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

No branches or pull requests

3 participants