search

bazelbuild / remote-apis

An API for caching and execution of actions on a remote system.
Apache License 2.0
331 stars 117 forks source link

rename module to remote-apis #309

Open mmorel-35 opened 3 weeks ago

mmorel-35 commented 3 weeks ago

Hi @philwo , @keith, As the module is not yet published to the bcr, I would to suggest to keep the name aligned with the project in github. Also it’s not yet really recommanded to persist the MODULE.bazel.lock so I removed it added it to gitignore

mostynb commented 3 weeks ago

Also it’s not yet really recommanded to persist the MODULE.bazel.lock so I removed it added it to gitignore

Do you have more info about why this is not recommended? https://bazel.build/external/lockfile lists the opposite in its best practices:

Include the lockfile in version control to facilitate collaboration and ensure that all team members have access to the same lockfile, promoting consistent development environments across the project.

mmorel-35 commented 3 weeks ago

I’m well awaee of this but the lock file quite often platform dependent so for the moment it’s not yet ready for being persistes on repositries. @keith , can you complete ?

keith commented 3 weeks ago

I think as of bazel 7.2.x+ it's ok to check in the lockfile, but previously as Matthieu said this file had a lot of thrash and might change across platforms, there's also probably not a ton of value in maintaining it in a repo like this, since its really the end user's lockfile that matters

EdSchouten commented 3 weeks ago

I'd actually be in favor of keeping the "bazel_" prefix. As the name implies, BCR is a central registry. There are many systems apart from Bazel that have "remote APIs".

bergsieker commented 2 weeks ago

Adding Tiago from the Bazel team to help us figure out what the best practices for BCR are. Browsing the existing modules, I see some with relatively generic names, but none quite as likely to be overloaded as "remote-apis." At the same time, I like not having the "bazel" prefix as a way to emphasize that this API is not specific to or defined by Bazel.

tjgq commented 2 weeks ago

@Wyverald Can you advise on BCR module naming?

Wyverald commented 2 weeks ago

I like bazel_remote_apis. Just remote_apis seems too generic.

If this is not Bazel-specific, I'm less sure what it should be named. remote-build-apis? How are these APIs referred to usually, outside of a Bazel-specific context?

(BTW hypher vs underscore is irrelevant, both are fine.)