Additional Flags for CustomFileBuildStepData #322
Conversation
This adds two new flags - ResolveExecutable: whether or not to pass Executable through resolver - DependOnExecutable: whether or not to add Executable to AdditionalInputs
Sharpmake/Project.Configuration.cs
Outdated
| @@ -2775,7 +2786,10 @@ internal void Resolve(Resolver resolver) | |||
| { | |||
| customFileBuildStep.Resolve(resolver); | |||
| Util.ResolvePath(Project.SourceRootPath, ref customFileBuildStep.KeyInput); | |||
| Util.ResolvePath(Project.SourceRootPath, ref customFileBuildStep.Executable); | |||
| if(customFileBuildStep.ResolveExecutable) | |||
There was a problem hiding this comment.
I don't understand why this is problematic for your to resolve the sharpmake variables.
if you don't have any variable of the format [project.XXXX] this won't do anything.
I'm not totally against this but I don't understand your use case.
There was a problem hiding this comment.
Hi, thanks for getting back to me!
Maybe I have configured something wrong but when that resolve happens, the project path gets appended to the executable name even if there are no [project.XXXX] variables to resolve. I have attached a screenshot to better demonstrate this, glslang is an executable in my Path and not inside the project tree.
There was a problem hiding this comment.
Hello,
Sharpmake assumes that the executable is in the SourceRootPath folder since you didn't specified an absolute path. In general however, from a build system point of view, relying on PATH to find your compiler is not really a recommended approach.
There is several reasons to this:
- Build will fail if your compiler is missing from path
- You will have build reproducibility issues(two machine could have different version of the compiler installed)
In general at ubisoft for these kind of things we generally use nugets for our various compilers and sdks(vs2022, console sdks etc). In some simple case with only a single .exe we sometimes publish the .exe in our source control. By doing these we insure build reproducibility. You should never rely on what is installed on a pc and especially not rely on what is in the PATH variable.
There was a problem hiding this comment.
Thank you for the explanation. Those are all valid points when it comes to real production, in my case its my personal codebase and when I use it anywhere I know about the limitations. This is mainly because I don't want to check in glslang because I don't want to waste space on my limited hosted server and git is really bad with binaries.
I'm sure you could find use cases for it across a team in specific situations but I'd imagine those are rare. If you think this sort of goes against the design of sharpmake then we can close the PR however if you think the base idea is valid but needs some changes I'd appreciate any feedback :)
Thank you for taking the time reviewing this.
There was a problem hiding this comment.
What I suggest you to do is if you know the full path to glslang, specify it in sharpmake. I think this will fix your problem
There was a problem hiding this comment.
Oh in terms of workarounds or fixing the problem, it also works to just have a custom class for customfildbuildstep. However both cases add a dependency to AdditionalInputs field hence why I have the other flag in there too.
- Consolidated ResolveExecutable and DepeonOnExecutable into one new flag called UseExecutableFromSystemPath
This mainly adds two flags,
ResolveExecutableandDependOnExecutable.First one is basically to skip prefixing the
Executablestring with the project path. This allows running of programs that are in the environment but not in the project.My use case was running a shader compiler while not adding the executable to the project.
The second flag is to skip adding the executable to the list of
AdditionalInputs, this preventsa warning when the executable is not found in the project.
The first flag has a workaround by overriding
MakeRelativePathsbut the second flag does not have any workaround I could find.I'm not extensively familiar with all potential problems that might come up with these flags so any feedback on it would be appreciated.