llvm-premerge-checks/README.md

This repo is holding VM configurations for machine cluster and scripts to run pre-merge tests triggered by http://reviews.llvm.org.

As LLVM project has moved to Pull Requests and Phabricator will no longer trigger builds, this repository will likely be gone.

Pull request migration schedule.

Overview

Presentation by Louis Dione on LLVM devmtg 2021 https://youtu.be/B7gB6van7Bw

The pre-merge checks for the LLVM project are a continuous integration (CI) workflow. The workflow checks the patches the developers upload to the LLVM Phabricator instance.

Phabricator (https://reviews.llvm.org) is the code review tool in the LLVM project.

The workflow checks the patches before a user merges them to the main branch - thus the term pre-merge testing*. When a user uploads a patch to the LLVM Phabricator, Phabricator triggers the checks and then displays the results.

The CI system checks the patches before a user merges them to the main branch. This way bugs in a patch are contained during the code review stage and do not pollute the main branch. The more bugs the CI system can catch during the code review phase, the more stable and bug-free the main branch will become. ^{citation needed}

This repository contains the configurations and script to run pre-merge checks for the LLVM project.

Feedback

If you notice issues or have an idea on how to improve pre-merge checks, please create a new issue or give a ❤️ to an existing one.

Requirements

The builds are only triggered if the Revision in Phabricator is created/updated via arc diff. If you update a Revision via the Web UI it will not trigger a build.

To get a patch on Phabricator tested the build server must be able to apply the patch to the checked out git repository. If you want to get your patch tested, please make sure that either:

• You set a git hash as sourceControlBaseRevision in Phabricator which is
• available on the Github repository, or you define the dependencies of your
• patch in Phabricator, or your patch can be applied to the main branch.

Only then can the build server apply the patch locally and run the builds and tests.

Contributing

We're happy to get help on improving the infrastructure and workflows!

Please check contibuting first.

Development gives an overview how different parts interact together.

Playbooks shows concrete examples how to, for example, build and run agents locally.

Additional Information

• Playbooks for installing/upgrading agents and testing changes.

• Log of the service operations

License

This project is licensed under the "Apache 2.0 with LLVM Exception" license. See LICENSE for details.