[Docs Update] Documentation about component splitting could use a better example

[LebedevRI]

Description

Let's suppose i have the following, fairly standard, source tree:

• src/dir1/some_name.rs
• src/dir1/tests.rs
• src/dir2/some_name.rs
• src/dir2/tests/something.rs
• src/dir2/tests/other/something.rs

How would one disable default aggregate component,
which shows total coverage for everything,
and add two non-overlapping components,
one for .*/tests.rs$ + .*/tests/.*,
and another for everything else,
that is not covered by the previous component?

There are mentions of prefixing the pattern with !,
but it isn't really obvious how it works.

I would think this is a fairly common situation,
so it might be good to explicitly document the solution.

Page(s)

https://docs.codecov.com/docs/components

Current State

[] Broken Link
[x] Unclear Language
[] Inconsistent Formatting
[x] Missing Information
[] Missing Updates for New Features
[] Deprecated Features

Additional Information

Apologies if this is filed against the wrong component...

[linear]

CCMRG-1423 [Docs Update] Documentation about component splitting could use a better example

[LebedevRI]

Ok, it turns out part of my issue was that YAML wasn't actually getting propagated to codecov, because codecov wasn't ever being run on actual commits, because ${{ env.FOO == true }} is of course the wrong check, ${{ env.FOO == 'true' }}.

As it seems, the following seems to work, so it might be good to mention something like this in the docs:

comment:
  layout: "header, files, diff, components, flags, footer"  # show component info in the PR comment
component_management:
  default_rules:
    statuses:
      - type: project
        target: auto
        informational: false
      - type: patch
        informational: false
  individual_components:
    - component_id: src
      name: source code
      paths:
        - "!**/tests.rs"
        - "!**/tests/**"
    - component_id: tests
      name: tests
      paths:
        - "**/tests.rs"
        - "**/tests/**"
coverage:
  status:
    project:
      default: false
    patch:
      default: false