Move download, SHA256 check and unzip of Windows buildenv from windows_buildenv.bat to CMakelists.txt by JoergAtGithub · Pull Request #13306 · mixxxdj/mixxx

JoergAtGithub · 2024-05-30T15:44:27Z

This move the VCPKG buildenv download, SHA256 verification and unzipping into CMakelists.txt. This removes the need for third party tools like 7zip and Powershell (see #11524 for reference).

For the developer everything should behave as before. No change in the build instructions is neccessary - just the tasks mentioned above are executed later.

Out of scope of this PR is:

macOS
Replacing windows_buildenv.bat and CMakeSettings.json by CMake Presets

daschuer

Thank for adopting this.

JoergAtGithub · 2024-07-16T22:19:29Z

@daschuer Friendly Ping

JoergAtGithub · 2024-08-16T22:13:50Z

@daschuer Can we merge this?

fwcd · 2024-08-16T23:24:57Z

 endif()

+
+if(WIN32)


I know you mentioned it as out-of-scope, but I agree that sharing this logic with macOS would be great, given that the vcpkg envs are structured practically identically as far as I understand.

It would be great if you could create a follow-up PR for macOS.

JoergAtGithub · 2024-09-07T12:55:35Z

@daschuer Can we merge this now?

daschuer

This only works if we make sure
"MIXXX_VCPKG_ROOT = BUILDENV_BASEPATH/BUILDENV_NAME"

What are the use cases if this is not the case?

If we tray to use an alternative build environment "MIXXX_VCPKG_ROOT" needs to be set.
If that exists, I think we can skip the whole evaluation of "BUILDENV_BASEPATH/BUILDENV_NAME"

In case it does not exists, I think there is no point in downloading to a diffrent folder than "MIXXX_VCPKG_ROOT".
So we may fail fatal in that case. However if we are in a shell where "BUILDENV_BASEPATH/BUILDENV_NAME" is set it will allways fail.

Conclusion we may only use "MIXXX_VCPKG_ROOT" and may dispose "BUILDENV_BASEPATH/BUILDENV_NAME"

What do you think?

acolombier · 2025-02-18T01:16:41Z

/softfix:squash

feat: move buildenv setup to CMakeFile

acolombier · 2025-02-18T01:32:02Z

/softfix

feat: move buildenv setup to CMakeFile

acolombier · 2025-02-18T02:17:18Z

@daschuer were your change requests addressed? Merge?

acolombier · 2025-02-18T12:03:52Z

Sorry for the early fixup @JoergAtGithub , I missred that PR and thought it was ready to go

JoergAtGithub · 2025-03-14T19:14:11Z

Restored original commits

JoergAtGithub · 2025-03-14T22:34:10Z

All done!

Eve00000 · 2025-03-15T06:55:32Z

All done!

Hi Jörg,
So if I understand it correct, you moved the downloading and extraction of the dependencies from the bat to cmake.
While working on these, can you please make the error-messages more clrear?
Before a lot of errors where covered under the message 'did you execute the windows_buildenv.bat' without mentioning the right error.
Can you also add a note at the beginning of the cmake to explain whitch lines need to be adapted if the dependencies are downloaded manual, and maybe some line to enter the name and sha of the latest dependencies that were downloaded manual.
Thank you.

JoergAtGithub · 2025-03-15T07:18:40Z

@Eve00000 The code with the message 'did you execute the windows_buildenv.bat' is not touched by this PR. This is therefore out of scope. The final goal is of cause to get rid of this batch file at all, but this is up to future PRs.

There is no need to modify the CMakelists.txt code when you use a zip file from other sources (a GitHub PR build artifact). Just manual download the ZIP file in the directory specified as BUILDENV_BASEPATH, set BUILDENV_NAME to the name of these manual downloaded file(without the file extension .zip).
For a command line build you could specify a manual downloaded buildenv zip by:
cmake ../ -DBUILDENV_BASEPATH="D:\mixxx\buildenv" -DBUILDENV_NAME="mixxx-deps-2.5-x64-windows-c15790e"
using an VisualStudio, you will find the same CMake settings in the GUI, where you can overwrite them.

Eve00000 · 2025-03-15T07:38:31Z

Cool!
I will give it a go this w-e.
I will post my findings & experience.

daschuer · 2025-03-15T08:07:31Z

@Eve00000 while testing, can you keep an eye in the documentation? I can imagine that some wiki docks needs to be adjusted, error messages rephrased.

daschuer · 2025-03-19T21:46:24Z

If the project is configured and the BUILD_ENV, we can't safely reconfigure. That's why the only chance we have that the buildenv variables can win is to ask for deleting the cache.

JoergAtGithub · 2025-03-19T21:51:02Z

Yes, that is the behavior we currently have and works very well for me. I will not change this in this PR!
Changenging the general behavior is out of scope of this PR!

daschuer

This works good on Linux as far as I can tell. I am pretty sure that clanging the environment without clearing the Cache does not work. But I can't prove it yet.

daschuer · 2025-03-19T23:10:42Z

Here is a CI run that demonstrates the issue
https://github.com/daschuer/mixxx/actions/runs/13958279397/job/39074483674
It configures the build directory as usual. Than It move the vcpkg package directory and re-configures the project with the new location and fails.

It will work, if the original environment still exists and you download the new in addition, However this leads to a dubious situation where some parts of the old and some parts of the new environment are used. I consider this as maximal confusing and therefore the early error message with a clear instruction is helpful.

…s_buildenv.bat to CMakelists.txt

JoergAtGithub · 2025-05-25T12:22:41Z

The requested fata error message is added, this is ready now!

JoergAtGithub · 2025-06-22T06:21:20Z

@daschuer A friendling ping, that this is ready to merge!

This additional condition doesn't harm my use cases Co-authored-by: Daniel Schürmann <daschuer@mixxx.org>

Co-authored-by: Daniel Schürmann <daschuer@mixxx.org>

Fix wrong variable use syntax in condition Unified directory seperator between BUILDENV_BASEPATH and BUILDENV_NAME Inhibited warnings about unused external specified variables if the buildenv is already there

daschuer

LGTM, Thank you.

github-actions Bot added the build label May 30, 2024

JoergAtGithub force-pushed the cmake_download_buildenv_zip branch from 22b1df5 to ecc462a Compare May 30, 2024 16:52

daschuer requested changes May 30, 2024

View reviewed changes

Comment thread CMakeLists.txt Outdated

Comment thread CMakeLists.txt Outdated

Comment thread CMakeLists.txt Outdated

JoergAtGithub requested a review from daschuer June 28, 2024 18:23

JoergAtGithub force-pushed the cmake_download_buildenv_zip branch from 9cea1ee to b09ace0 Compare June 29, 2024 07:09

fwcd reviewed Aug 16, 2024

View reviewed changes

daschuer requested changes Nov 26, 2024

View reviewed changes

Comment thread CMakeLists.txt Outdated

Comment thread CMakeLists.txt Outdated

Comment thread CMakeLists.txt Outdated

Comment thread CMakeLists.txt Outdated

JoergAtGithub force-pushed the cmake_download_buildenv_zip branch from b09ace0 to efa7b67 Compare February 9, 2025 16:36

acolombier mentioned this pull request Feb 18, 2025

Add softfix.yml #14341

Merged

github-actions Bot force-pushed the cmake_download_buildenv_zip branch from f1ac722 to 7db1d4f Compare February 18, 2025 01:25

github-actions Bot force-pushed the cmake_download_buildenv_zip branch from 7db1d4f to 8779ff3 Compare February 18, 2025 01:43

daschuer requested changes Feb 18, 2025

View reviewed changes

Comment thread CMakeLists.txt Outdated

JoergAtGithub mentioned this pull request Mar 14, 2025

Detect arch and fail early if not supported when installing buildenv #14478

Merged

JoergAtGithub force-pushed the cmake_download_buildenv_zip branch from 8779ff3 to f1ac722 Compare March 14, 2025 18:14

github-actions Bot added the developer experience Issues, bugs and PRs related to the development process, development environment & developer docs label Mar 14, 2025

JoergAtGithub added this to the 2.6-beta milestone Mar 14, 2025

JoergAtGithub requested a review from daschuer March 14, 2025 22:34

daschuer requested changes Mar 19, 2025

View reviewed changes

Comment thread CMakeLists.txt Outdated

daschuer reviewed Mar 19, 2025

View reviewed changes

Comment thread CMakeLists.txt Outdated

acolombier added this to Releases Mar 25, 2025

github-project-automation Bot moved this to In progress in Releases Mar 25, 2025

daschuer modified the milestones: 2.6-beta, 2.6.0 May 12, 2025

JoergAtGithub force-pushed the cmake_download_buildenv_zip branch from 04db0c1 to cf364ea Compare May 25, 2025 10:26

JoergAtGithub changed the base branch from main to 2.6 May 25, 2025 11:05

Move download, SHA256 check and unzip of Windows buildenv from window…

c6066d0

…s_buildenv.bat to CMakelists.txt

JoergAtGithub force-pushed the cmake_download_buildenv_zip branch from cf364ea to c6066d0 Compare May 25, 2025 11:23

JoergAtGithub requested a review from daschuer May 25, 2025 12:22

daschuer requested changes Jun 26, 2025

View reviewed changes

Comment thread CMakeLists.txt Outdated

Update CMakeLists.txt

40a36d8

This additional condition doesn't harm my use cases Co-authored-by: Daniel Schürmann <daschuer@mixxx.org>

JoergAtGithub requested a review from daschuer June 26, 2025 21:11

daschuer requested changes Jun 26, 2025

View reviewed changes

Comment thread CMakeLists.txt Outdated

Update CMakeLists.txt

6f5c157

Co-authored-by: Daniel Schürmann <daschuer@mixxx.org>

JoergAtGithub requested a review from daschuer June 26, 2025 21:31

daschuer requested changes Jun 26, 2025

View reviewed changes

Comment thread CMakeLists.txt Outdated

Comment thread CMakeLists.txt

Prefer CMake variables over ENV variables

66d70b1

Fix wrong variable use syntax in condition Unified directory seperator between BUILDENV_BASEPATH and BUILDENV_NAME Inhibited warnings about unused external specified variables if the buildenv is already there

JoergAtGithub requested a review from daschuer June 27, 2025 00:36

daschuer approved these changes Jun 27, 2025

View reviewed changes

daschuer merged commit 66f2d35 into mixxxdj:2.6 Jun 27, 2025
3 checks passed

github-project-automation Bot moved this from In progress to Done in Releases Jun 27, 2025

JoergAtGithub deleted the cmake_download_buildenv_zip branch June 27, 2025 20:28

JoergAtGithub mentioned this pull request Jun 29, 2025

Move VCPKG to GH Release #14477

Draft

		endif()


		if(WIN32)

Uh oh!

Conversation

JoergAtGithub commented May 30, 2024

Uh oh!

daschuer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoergAtGithub commented Jul 16, 2024

Uh oh!

JoergAtGithub commented Aug 16, 2024

Uh oh!

fwcd Aug 16, 2024

Choose a reason for hiding this comment

Uh oh!

JoergAtGithub Aug 16, 2024

Choose a reason for hiding this comment

Uh oh!

JoergAtGithub commented Sep 7, 2024

Uh oh!

daschuer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acolombier commented Feb 18, 2025

Uh oh!

acolombier commented Feb 18, 2025

Uh oh!

acolombier commented Feb 18, 2025

Uh oh!

Uh oh!

acolombier commented Feb 18, 2025

Uh oh!

JoergAtGithub commented Mar 14, 2025

Uh oh!

JoergAtGithub commented Mar 14, 2025

Uh oh!

Eve00000 commented Mar 15, 2025

Uh oh!

JoergAtGithub commented Mar 15, 2025

Uh oh!

Eve00000 commented Mar 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daschuer commented Mar 15, 2025

Uh oh!

daschuer commented Mar 19, 2025

Uh oh!

JoergAtGithub commented Mar 19, 2025

Uh oh!

daschuer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

daschuer commented Mar 19, 2025

Uh oh!

JoergAtGithub commented May 25, 2025

Uh oh!

JoergAtGithub commented Jun 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daschuer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Eve00000 commented Mar 15, 2025 •

edited

Loading