stride3d / stride3d/stride

Follow Readme.md "Building from source" lead to slow build (due to test projects) and contains an error when Stride.sln is initially opened (because of a test project).

Open
#730 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug priority-high work-estimate-M
Dominant language
C#
Stars
7.8k
Forks
1.2k
Avg merge
2d 17h
Merged PRs (30d)
49

Description

Release Type
Github

Version
master (latest: 4f117bcf09ac6dae6d957781d743d36272bfb386 )

Platform(s): Does the problem occur on Windows, Android...?
Windows

Describe the bug
I followed the Readme.md "Building from source" at one step it says open build/Stride.sln
After visual studio is loaded with solution it directly shows an error in Stride.VisualStudio.Package.Tests.csproj.

On this line:
<Exec Command="&quot;..\..\core\Stride.Core.Tasks\bin\$(Configuration)\$(StrideEditorTargetFramework)\Stride.Core.Tasks.exe&quot; locate-devenv &quot;$(MSBuildBinPath)&quot;" ConsoleToMsBuild="true">

Problem is that the .exe is not (yet) build.
Also the default "Build" (Solution) is very slow due to tests being included (especially due toStride.Core.Assets.Editor.Tests).

To Reproduce

Follow "Building from source" in of README.md

Expected behavior

Test should be placed in their own build configuration.

This fixes two things

  1. The error no longer occurs with default "build"
  2. (First time) users that follow the readme with building from source are not detered from using the engine (since they see an error and building is slow due to tests).

Note: You can easilly fix this problem by clicking the "Mixed Platforms" dropdown -> New -> Clone "Mixed Platforms" change to "Tests" -> Close.
Edit "Mixed Platforms" and uncheck all project containing the word "Test.

Screenshots
If applicable, add screenshots to help explain your problem (use GitHub drag & drop)
Not applicable.

Log and callstacks
If any, please attach here any log or callstack (preferably in a .txt file using GitHub drag and drop)
Not applicable.

Additional context
Add any other context about the problem here.

Other engine's like the unreal engine also don't force their dev users to build their unit tests.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md's "Building from source" instructions and build/Stride.sln. Inspect Stride.VisualStudio.Package.Tests.csproj, especially the Exec command for Stride.Core.Tasks.exe, and review how test projects are included in the default solution build. Done means opening the solution and running the default build without that error or unnecessary test-project build time.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system, documentation, testing-qa
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.