Skip to content

Downloading and running test builds

Casper Jeukendrup edited this page Aug 20, 2024 · 2 revisions

Summary

Downloading Nightly Builds

Every night, a test build is created from the very latest development version of MuseScore. You can download these test builds from the following server: https://ftp.osuosl.org/pub/musescore-nightlies/.
Scherm­afbeelding 2022-10-15 om 22 05 37

Under "4.x (master)", click the "Nightly" link for your OS. (Important: don't use the "beta" link; currently, that only leads to a very outdated version.)

This should bring you to a page like this:
Scherm­afbeelding 2022-10-15 om 22 06 04

The builds are sorted by date; the newest one is at the top. You can also simply use the build called "Latest", which always points to the latest build.

Downloading Builds from Pull Requests

New fixes and changes are offered through Pull Requests. This allows us to review and test the changes before they are promoted to the master branch.

When a developer opens or amends a Pull Request, a test build is created. This enables you to run their code without having to compile it yourself. But don't forget, their code hasn't been approved yet, so only do this if you trust the developer in question.

In order to download the test build:

  1. Sign in to your GitHub account (it's free to create one if you need to).

  2. Navigate to the web page of the Pull Request. Here, we will use PR #13774 as an example.

  3. Switch to the "Checks" tab at the top of the page:
    Scherm­afbeelding 2024-08-20 om 14 05 28

  4. In the side bar, you should see among others:

    • Build: macOS
    • Build: Linux
    • Build: Windows

    You may need to scroll a bit to see them.

    Click the one corresponding to your OS. (Click on the name itself; not on the little '>' icon in front of it, nor the build_mu4 line below it.)

    Example for Windows:
    Scherm­afbeelding 2024-08-20 om 14 52 36

  5. This should bring you to a page like this:

    Scherm­afbeelding 2024-08-20 om 14 55 17
  6. At the bottom of this page, in the "Artifacts" section, you should find a download link to download the test build:

    Scherm­afbeelding 2024-08-20 om 14 56 01

    If you can't click the artifact link then either the artifact has expired (they are deleted after 90 days) or you are not signed in to GitHub.

Running Test Builds

Remember, test builds contain code that has not yet been checked and approved by our internal team. Only run test builds if you trust the developer in question. Always keep an external backup of important files.

macOS

  1. For Pull Request builds only: if the downloaded file is a .zip file, unpack it (for example using macOS's built-in Archive Utility). Otherwise, your browser has already unpacked it for you. Open the resulting folder.
  2. Open the .dmg file. You should see something like this:
    Scherm­afbeelding 2022-10-15 om 22 48 35
  3. To keep your applications folder clean, it is recommended that you don't drag the MuseScore icon to your Applications folder.
  4. Double-click the MuseScore icon to run the test build.

For Pull Request builds, some additional effort is required. To save resources, these builds are namely not "notarized" by Apple, even though they are just as safe as other builds. This causes an error message like this:
Scherm­afbeelding 2022-10-15 om 22 59 05
(Sorry for the Dutch screenshot)

Click "Cancel". Then, right-click or Control+click the MuseScore icon, and chose "Open".
Scherm­afbeelding 2022-10-15 om 23 00 31

Linux

On Linux, the (unzipped) download is an AppImage. You can use it like any other AppImage.

Windows

  1. Extract the downloaded .zip file.
  2. This should result in a .7z file. Use the 7-Zip tool to extract this file.
  3. In the resulting folder, go to the bin subfolder, and double-click MuseScore4.exe to run it.

Note: Nightly builds and builds from Pull Requests are not "installed", but you can simply run them. This helps to keep your computer clean, and to ensure that test builds don't interfere with stable builds.

Testing

Translation

Compilation

  1. Set up developer environment
  2. Install Qt and Qt Creator
  3. Get MuseScore's source code
  4. Install dependencies
  5. Compile on the command line
  6. Compile in Qt Creator

Beyond compiling

  1. Find your way around the code
  2. Submit a Pull Request
  3. Fix the CI checks

Misc. development

Architecture general

Audio

Engraving

Extensions

Google Summer of Code

References

Clone this wiki locally