Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[7.1.0] The label API shakeup & docs cleanup #20977

Merged
merged 2 commits into from
Jan 22, 2024
Merged

[7.1.0] The label API shakeup & docs cleanup #20977

merged 2 commits into from
Jan 22, 2024

Commits on Jan 22, 2024

  1. The label API shakeup & docs cleanup 

    Been a long time coming.

* `native.repository_name()` is deprecated (has a spurious `@` prefix). A new method `native.repo_name()` is introduced instead.
* `Label.workspace_name` is deprecated (misnomer). A new field `Label.repo_name` is introduced instead.
* `Label.relative()` is deprecated (error-prone). A new method `Label.local_target_label()` is introduced with narrowed focus, alongside which `native.package_relative_label()` and `Label()` are recommended as replacements.

And then a bunch of documentation cleanups, hopefully reducing any potential confusion.

Fixes #16210.

RELNOTES:
Various methods and fields related to labels and repos are deprecated in favor of new options with clearer naming and intent. The deprecated APIs can be disabled by setting `--noincompatible_enable_deprecated_label_apis`.
* `native.repository_name()` is deprecated in favor of the new `native.repo_name()`.
* `Label.workspace_name` is deprecated in favor of the new `Label.repo_name`.
* `Label.relative()` is deprecated in favor of the new `Label.local_target_label()` alongside the existing `native.package_relative_label()` and `Label()`.
PiperOrigin-RevId: 590712228
Change-Id: I1724f3c4f3c21876a67f4a0291f6ebc0a1fa4b75
    @Wyverald
    Wyverald committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    291cb02 View commit details
    Browse the repository at this point in the history

  2. Rename Label.local_target_label to Label.same_package_label 

    "local" is an incredibly overloaded term.

Follow-up for #16210

RELNOTES: Label.local_target_label is renamed to Label.same_package_label.
PiperOrigin-RevId: 591940544
Change-Id: Ic050234471dc7c729a014794de57590a145b1e34
    @Wyverald
    Wyverald committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    6769e35 View commit details
    Browse the repository at this point in the history