brave-core

Brave Core Brave Core is a set of changes, APIs, and scripts used for customizing Chromium to make the Brave browser. Please also check https://github.com/brave/brave-browser which only holds the issues, releases and the wiki. Overview This repository holds the build tools needed to build the Brave desktop browser for all platforms. In particular, it fetches and syncs code from the projects defined in package.json and src/brave/DEPS: Chromium Fetches code via depot_tools. Sets the branch for Chromium (ex: 65.0.3325.181). brave-core Mounted at src/brave. Maintains patches for 3rd party Chromium code. adblock-rust Implements Brave's adblock engine. Linked through brave/adblock-rust-ffi. Resources Documentation and guides Issues Releases Wiki Downloads You can visit our website to get the latest stable release. Contributing Please see the contributing guidelines. Our Wiki also has some useful technical information, especially about setting the development environment. Security Policy Please see the security policy. Community Join the Q&A community if you'd like to get more involved with Brave. You can ask for help, discuss features you'd like to see, and a lot more. We'd love to have your help so that we can continue improving Brave. You can also ask questions and interact in the community-guest channel on Brave Software's Slack. Help us translate Brave to your language by submitting translations at https://explore.transifex.com/brave/brave_en/. Follow @brave on X for important news and announcements. Install prerequisites Follow the instructions for your platform: Android Linux iOS macOS Windows Clone and initialize Once you have the prerequisites installed, you can get the code and initialize the build environment. Clone the repo. brave-core must be checked out into ./src/brave within a pre-existing project folder: git clone git@github.com:brave/brave-core.git path-to-your-project-folder/src/brave cd path-to-your-project-folder/src/brave Initialize the build environment. This step will download the Chromium source, which has a large history (10's of gigabytes of data). This might take a really long time to finish depending on internet speed. # Most builds: pnpm run init # Android builds (replace `arm` with whichever CPU type you want to build for): pnpm run init --target_os=android --target_arch=arm # iOS builds: pnpm run init --target_os=ios Additional config needed to build are documented at https://github.com/brave/brave-browser/wiki/Build-configuration Internal developers can find more information at https://github.com/brave/internal/wiki/Build-configuration Build Brave The default build type is component. # start the component build compile pnpm run build To do a release build: # start the release compile pnpm run build Release brave-core based android builds should use pnpm run build --target_os=android --target_arch=arm brave-core based iOS builds should use the Xcode project found in ios/brave-ios/App. You can open this project directly or run pnpm run ios_bootstrap --open_xcodeproj to have it opened in Xcode. See the iOS Developer Environment for more information on iOS builds. Build Configurations Running a release build with pnpm run build Release can be very slow and use a lot of RAM, especially on Linux with the Gold LLVM plugin. To run a statically linked build (takes longer to build, but starts faster): pnpm run build Static To run a debug build (Component build with is_debug=true): pnpm run build Debug NOTE: the build will take a while to complete. Depending on your processor and memory, it could potentially take a few hours. Run Brave To start the build: pnpm start [Release|Component|Static|Debug] Update Brave pnpm run sync [--force] [--init] [--create] [brave_core_ref] This will attempt to stash your local changes in brave-core, but it's safer to commit local changes before running this pnpm run sync will (depending on the below flags): 📥 Update sub-projects (chromium, brave-core) to latest commit of a git ref (e.g. tag or branch) 🤕 Apply patches 🔄 Update gclient DEPS dependencies ⏩ Run hooks flag Description [no flags] updates chromium if needed and re-applies patches. If the chromium version did not change, it will only re-apply patches that have changed. Will update child dependencies only if any project needed updating during this script run. **Use this if you want the script to manage keeping you up to date instead of pulling or switching branches manually. ** --force updates both Chromium and brave-core to the latest remote commit for the current brave-core branch and the Chromium ref specified in brave-core/package.json (e.g. master or 74.0.0.103). Will re-apply all patches. Will force update all child dependencies. **Use this if you're having trouble and want to force the branches back to a known state. ** --init force update both Chromium and brave-core to the versions specified in brave-core/package.json and force updates all dependent repos - same as pnpm run init --sync_chromium (true/false) Will force or skip the chromium version update when applicable. Useful if you want to avoid a minor update when not ready for the larger build time a chromium update may result in. A warning will be output about the current code state expecting a different chromium version. Your build may fail as a result. -D, --delete_unused_deps Will delete from the working copy any dependencies that have been removed since the last sync. Mimics gclient sync -D. Run pnpm run sync brave_core_ref to checkout the specified brave-core ref and update all dependent repos including chromium if needed. Scenarios Create a new branch: > cd src/brave src/brave> git checkout -b branch_name Checkout an existing branch or tag: src/brave> git fetch origin src/brave> git checkout [-b] branch_name src/brave> pnpm run sync ...Updating 2 patches... ...Updating child dependencies... ...Running hooks... Update the current branch to the latest remote: src/brave> git