bazelbuild/bazel

Documentation issue: Repository Rules

Open

#10,979 opened on Mar 18, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-ExternalDepstype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

Documentation URL: https://docs.bazel.build/versions/2.1.0/skylark/repository_rules.html

The example implementation of local_repository does not work with bazel 2.1.1 when "path" is specified as relative path to the calling workspace. Yielding error: "rule //external:<repository_name> must create a directory".

Manual inspection of the repository path found repository_ctx.attr.path being resolved as relative path to the repository directory instead of the workspace directory in repository_ctx.symlink.

Also, is there a way to manually resolve a path relative to workspace directory?

Contributor guide

Research direction
Investigate how repository ctx.attr.path is resolved and ensure the example works with relative paths. Update the documentation accordingly.
Tech stack
java
Domain
build system
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
BazelStarlark
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60