bazelbuild / bazelbuild/rules_pkg

Clarify validity requirements in docs of PackageFilesInfo/PackageFilegroupInfo

Open
#746 3 comments 0 reactions 0 assignees View on GitHub
documentation need more information P3
Dominant language
Starlark
Stars
253
Forks
221
Avg merge
10h 33m
Merged PRs (30d)
1

Description

Is it invalid (meaning under no circumstances a good idea, assumed by consuming rules not to happen) to have
- A `PackageFilegroupInfo` that contains the same destination file twice? I assume yes, c.f. #682
- A `PackageFilesInfo` that contains directory `File`s?
- A `PackageFilesInfo` that contains symlink `File`s?
- One or two `PackageFilesInfo` in the same `PackageFilegroupInfo` containing both a file `a/b` and a file `a/b/c`, where `a/b` is a regular or symlink `File`?
- One or two `PackageFilesInfo` in the same `PackageFilegroupInfo` containing both a file `a/b` and a file `a/b/c`, where `a/b` is a directory `File`?

Imo it would be helpful to mention that in the docs of the respective provider. That way, these providers can become a more standardized interface between producing and consuming rules.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.