bazel-contrib / bazel-contrib/rules_go
go_embed_data deprecation comment is confusing and unhelpful
- Dominant language
- Go
- Stars
- 1.5k
- Forks
- 760
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 12
Description
### What version of rules_go are you using?
v0.32.0
### What version of gazelle are you using?
v0.25.0
### What version of Bazel are you using?
5.1.1
### What did you do?
When you build something that uses go_embed_data, it prints out this message:
```
Embedding is now better handled by using rules_go's built in https://github.com/bazelbuild/rules_go/blob/master/docs/go/core/embedding.md functionality. The `bindata` rule is deprecated and will be removed in rules_go version 0.35.
```
### What did you expect to see?
I would expect to see a message that talks about the rule I'm using. I've never heard of `bindata` before.
I also expect the url in the message to go somewhere useful. E.g. at a minimum explain how to use go:embed with bazel. Preferably also explain how to migrate from go_embed_data to go:embed
### What did you see instead?
The linked page talks about the embed attribute on a go_library, not how to use `go:embed`.
Contributor guide
Research direction
Search the go_embed_data and bindata deprecation-message implementation, then read the linked rules_go embedding documentation and its go_library embed attribute guidance. Update the message and documentation so they identify the rule in use, explain go:embed with Bazel, and describe migration from go_embed_data; verify the build output and relevant documentation checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100