Coveralls logob
Coveralls logo
  • Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

Better Monorepo Support including Carryforward Flags and UI Improvements

We're happy to announce better support for monorepos, including Carryforward Flags and UI improvements like the Monorepo Layout Setting.

Monorepo flag head


Carryforward Flags

We know you don't want to build every subproject in your monorepo every time one of your teams submits a PR. So from now on, only send coverage reports for the subprojects you’re building in CI. We’ll carry forward the last coverage report for all the other subprojects and calculate total coverage like any other parallel build:

Monorepo flag 01


UI Improvements

We also know you think about your monorepos differently from users with regular projects, so we've updated our UI with a Monorepo Layout Setting to switch up the layout for monorepos:

Monorepo flag 02

This new option labels subprojects clearly and better isolates coverage reporting between them:

Monorepo flag 03

Instructions

First, if you haven't already, opt-in to Carryforward Flags:

Turn On Carryforward Flags

We'll reply when the feature is ON for your repos.


Carryforward Flags

Here's how to manually configure an existing parallel build to carry forward some of its existing jobs ✢:

  • Step 1: In your CI config file, make sure each job in your parallel build uses a "flag name"—this Github Action example uses flag-name to name each job:
Carryforward flags 01
  • Step 2: Find your parallel build's call to the Close Parallel Build Webhook—if you're using the "close build" convenience feature of your integration, you may need to convert it to a straight curl command:
Carryforward flags 02
  • Step 3: Add the ?carryforward= URL param to the end of that call's URL and append a list of all flag names to be carried forward:
Carryforward flags 03

✢ Note: Currently, no Coveralls integrations support Carryforward Flags out-of-the-box. We will fix that once we release official support for the feature.

Monorepo Layout Setting
  • Step 1: Go to REPO SETTINGS for your monorepo
  • Step 2: Select monorepo for Repo TYPE:
Monorepo layout setting 01
  • Step 3: Click Save Changes
Monorepo layout setting 02
  • Now verify that your Build Pages now list “Subprojects” instead of “Jobs”
Monorepo layout setting 03


Help us improve:

  • Testing Carryforward Flags? Send us your issues or UX feedback.
  • Testing the Monorepo Layout Setting? Send us your issues or UX feedback.
  • Other thoughts or suggestions? Send us quick feedback.
Sign Up Now Integration Docs PRIVATE REPO PRICING
Troubleshooting · Open an Issue · Sales · Support · ENTERPRISE · CAREERS · STATUS
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2023 Coveralls, Inc