Enable sourcelink - Githubissues

AdamsLair / duality

a 2D Game Development Framework

https://adamslair.github.io/duality

MIT License

1.4k stars 289 forks source link

Enable sourcelink #746

Closed Barsonax closed 4 years ago

Barsonax commented 4 years ago

Summary

Sourcelink would enable consumers of duality to debug it like they had the source code. For instance here iam doing just that with Singularity while its installed in a console app: demo

https://github.com/dotnet/sourcelink

Analysis

No more copying over dll's and pdb's just to be able to debug duality source code from another project. Just disable just my code and you are good to go.
Was easy to setup in a evening for Singularity.

ilexp commented 4 years ago

Done by @mdonoughe. Closing this.

ilexp commented 4 years ago

Unfortunately we'll have to re-open this as it turns out that SourceLink doesn't work when building packages via AppVeyor CI, rendering the recent addition inactive.

The following messages show up in the CI build:

Source control information is not available - the generated source link is empty. Unable to locate repository with working directory that contains directory 'C:\projects\duality\Source\Core\Duality'.

@mdonoughe Do you have any idea how this could be addressed?

Barsonax commented 4 years ago

Seems to be a hardcoded path?

ilexp commented 4 years ago

It's not a path from my machine, if that's what you're wondering - I'd guess it's just the directory where AppVeyor happens to store the project checkout.

ilexp commented 4 years ago

Did a bit of research and I'm guessing it could be this AppVeyor setting:

# fetch repository as zip archive
shallow_clone: true

If there's no git, then of course SourceLink has no way of knowing where to link to. I'll try disabling this on the release branch and see if it helps.

ilexp commented 4 years ago

That seems to have done it, the warnings are gone. I've triggered a new binary release that should now have SourceLink support, should be out there in about 30 minutes.