-
Notifications
You must be signed in to change notification settings - Fork 4.3k
doc: add "best practices" for module version
and compatibility_level
#26356
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the writeup. I found it quite enlightening, myself :)
I do wonder whether this new content belongs on this page, since this is quite in-depth stuff that goes beyond the introduction of basic concepts (such as the version format, how selection works, etc). Although I don't immediately have a better idea where to put it either (maybe in the rules template itself, or maybe in faq.md?) WDYT?
thanks! :)
I'm happy to move this to wherever any of you see fit, but I really think this is the best place for this stuff. These were the docs I read before asking in Slack... basically, I went through the steps I mentioned and I didn't find the answers I was looking for. I think it has all the context required to understand the issues that arise from setting the version in the source The way I see it, if you land in this page, either you are coming from the Either way, this is the page that discusses most of the important stuff about the external dependencies and, tbh, most of the concepts in this page are quite complex and in-depth already 😅 so I think it's quite fitting! I think rules-template or a separate FAQ would be more removed from context. And I've already added comments to the rules-template Happy to hear more reviewers / ideas, and as I said, I'll move it to wherever you think is best. Thanks! |
@Wyverald I've given it more thought and I've moved it to FAQ, I think you are right, it can also fit in there and this way the "Bazel modules" page won't be more / so overwhelming 😅 . Let me know what you think! |
86d88d5
to
8546b0d
Compare
While asking about best practices regarding releasing Bazel modules in Slack, I learned a few things that I would have loved to see in the Bazel docs (e.g. leaving the version unset or set to the default "" value can prevent issues like bazel-contrib/rules_go#4380 when the module is used via non-registry overrides). For more info, see bazel-contrib/rules-template/pull/148 and this Slack thread: https://bazelbuild.slack.com/archives/CA31HN1T3/p1750406404452179
8546b0d
to
3b662fa
Compare
@Wyverald could you check the changes and see if the new version in FAQ is better? 🙏 Thanks! |
While asking about best practices regarding releasing Bazel modules in Slack, I learned a few things that I would have loved to see in the Bazel docs (e.g. leaving the version unset or set to the default
""
value can prevent issues like bazel-contrib/rules_go#4380 when the module is used via non-registry overrides).For more info, see bazel-contrib/rules-template/pull/148 and this Slack thread:
https://bazelbuild.slack.com/archives/CA31HN1T3/p1750406404452179