Skip to content

Don't bundle DocC documentation catalogs as resources - #3102

Closed
louwers wants to merge 1 commit into
bazelbuild:mainfrom
louwers:skip-docc-catalog-resources
Closed

louwers wants to merge 1 commit into
bazelbuild:mainfrom
louwers:skip-docc-catalog-resources

Conversation

@louwers

@louwers louwers commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

A .docc catalog in the data of a library is only used by docc_archive to build documentation, but it is also copied into every bundle that depends on the library as unprocessed resources. For example, the HelloWorldSwift example app currently ships HelloWorldSwift.app/HelloWorldSwift.docc/README.md.

When a catalog's files are listed individually (e.g. with a glob), they are also flattened into the root of the bundle. The basic_framework_with_docc_bundle test fixture currently contains both basic.docc/README.md and README.md, which can conflict with other resources.

This skips files in .docc catalogs when bucketizing resources, matching Xcode, which never copies documentation catalogs into products. docc_archive reads the catalog from data through its own aspect, so it is not affected.

Testing

  • Added docc_ios_framework_does_not_contain_docc_bundle, which fails without this change.
  • bazel test //test/starlark_tests:docc passes.

🤖 Generated with Claude Code

A `.docc` catalog in the `data` of a library is only used by
`docc_archive` to build documentation, but was also copied into the
bundles depending on the library as unprocessed resources. When the
catalog's files are listed individually, they're even flattened into the
root of the bundle, where they can conflict with other resources.

Skip files in `.docc` catalogs when bucketizing resources, matching
Xcode, which never copies documentation catalogs into products.

Assisted-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant