bazelbuild / bazelbuild/bazel

Add docstring to `bazel sync --experimental_repository_resolved_file` output

Open
#14,537 0 comments 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-ExternalDeps type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

### Description of the problem / feature request:

The `bazel sync --experimental_repository_resolved_file` output should include a module docstring.

### Feature requests: what underlying problem are you trying to solve with this feature?

The resolved file currently fails the [`buildifier` module-docstring`](https://github.com/bazelbuild/buildtools/blob/master/WARNINGS.md#module-docstring) lint check.

### What operating system are you running Bazel on?

Linux, macOS

### What's the output of `bazel info release`?

`release 4.2.1`

### Have you found anything relevant by searching the web?

- bazelbuild/bazel#14454 (this issue is about formatting, this issue is about missing content)

Contributor guide

Open the contributing guide

Research direction

Start by tracing the output produced by `bazel sync --experimental_repository_resolved_file` and review the linked Buildifier `module-docstring` lint check. The work is done when the resolved file includes a module docstring and no longer fails that lint check.

Written by the indexing model from the issue text.

Assessment

Domain
build-system
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.