Skip to content


ronso0 edited this page Feb 23, 2024 · 31 revisions

As we develop new features and fix bugs for Mixxx, we need feedback from users. Testing the latest developments is a great way to contribute to Mixxx.

Backup settings and database

We try to ensure that upgrading to new versions does not interfere with settings from older versions, but we might not catch every potential issue immediately. Before switching from a stable release of Mixxx to a development version, it is recommended to make a backup copy of your settings and library database, as well as your controller mappings and track waveforms (if you chose to store them).
You can backup all that by copying this whole folder:

Note: make sure you have 'Show hidden files' enabled in your file manager in order to show all dot-files and folders.

Vista and up: %LOCALAPPDATA%\Mixxx\
XP and below: %USERPROFILE%\Local Settings\Application Data\Mixxx\
Type either of those into the location bar of a Computer or Folder window.

Mixxx 2.3: ~/Library/Containers/org.mixxx.mixxx/Data/Library/Application Support/Mixxx
Mixxx 2.2 and earlier: ~/Library/Application Support/Mixxx

Main branch builds

Every time we change the code, GitHub Actions makes a build and uploads it to We try to keep the main branch reasonably stable and not merge new features until we're fairly confident they are not going to create serious issues. However, if you want to perform with these, do so at your own risk. If you do decide to perform with a main branch build, test the same build for several practice sets before your gig to check that it works with your particular setup. If you encounter a bug, please report it.

If you are using a Linux distribution other than Ubuntu or a derivative distribution that is incompatible with Ubuntu .deb packages, you will need to compile from source code to test the main Git branch.

GitHub pull requests

If you would really like to be on the bleeding edge, you can try out pull requests on GitHub before they get merged to the main branch. This way you can be involved in the design of new features as they are being implemented. If there is an issue with a build from a pull request, comment on the pull request on GitHub instead of filing a bug report.

You can either

  • download binaries created by Github CI, or
  • checkout the PR branch locally and built yourself.

Download binaries build by Github CI

GitHub Actions automatically builds every pull request. They are not uploaded to, but you can access them through GitHub. If you do not have a GitHub account already, you will need to register one and log in to download pull request builds.

Go to the bottom of the pull request and look at the report of the builds & test results below the last comment on the page. Click "Show all checks" Screenshot of GitHub Actions checked on a pull request (collapsed)

Click the "Details" link next to any check that starts with "Build /". Screenshot of GitHub Actions checks on a pull request

On the next page, click the "Summary" link in the top left.
Screenshot of the Summary link

Then, scroll down to the bottom of the page where you will encounter the "Artifacts" section where all the installers produced by that pull request will be listed. Screenshot of the Artifacts section

Click the link to download the build for your operating system. GitHub Actions automatically wraps the installer in a ZIP file, so you need to extract the ZIP file before running the installer.

Pull request builds are not code signed, so macOS and Windows will warn you about installing them.

To run unsigned builds on macOS, right click on the file in Finder and select "Open". macOS will warn you about the build being from an unidentified developer but it will let you run it anyway. Refer to this article for more details.

To run unsigned builds on Windows, double click the .msi installer as usual. In the popup that says "Windows protected your PC", click the "More info" link just below the "Windows protected your PC" text. Then, a button will appear in the bottom right of the popup that says "Run anyway". Click that new "Run anyway" button.

For Linux distributions other than Ubuntu, you will need to compile Mixxx from source yourself. Refer to the Using Git wiki page for how to set up Git on your computer for downloading the code to test pull requests.

Build PR branches yourself

If you already have a git setup, forked the Mixxx repo and are able to build Mixxx, you can checkout PR branches without having to add the remote repo of contributor (PR creator). This is possible with either git

git checkout upstream/pr/PULL-REQUEST-NUMBER

or the gh utility

gh pr checkout (-f) [PULL-REQUEST-NUMBER]

Testing Zulip stream

When we need people to test specific pull requests, we will post in the #testing Zulip stream.

Clone this wiki locally