Skip to content
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

documentation for using via module.bazel #2670

Open
pdeva opened this issue May 31, 2024 · 2 comments
Open

documentation for using via module.bazel #2670

pdeva opened this issue May 31, 2024 · 2 comments

Comments

@pdeva
Copy link

pdeva commented May 31, 2024

current docs are focused on using WORKSPACE file..

@marvin-hansen
Copy link
Contributor

@pdeva I've just made an end to end example of a Rust repo using module.bazel and added some basic docs.

https://github.com/marvin-hansen/bazel_rust_example

However, there is still one open issue, which I try to resolve:
#2689

@marvin-hansen
Copy link
Contributor

The first draft of the Rust with Bzlmod documentation is available now:

https://github.com/marvin-hansen/bazel_rust_example/blob/main/bzlmod.md#rust-with-bzlmod

Once the doc is reasonably ready, it will be merged into the official documentation. In the meantime,
feedback is welcome.

github-merge-queue bot pushed a commit that referenced this issue Jul 12, 2024
This PR provides documentation of Bazelmod and several code examples
that addresses a number of issues related to Bazelmod.

Preview of the documentation:
https://github.com/marvin-hansen/rules_rust/blob/main/docs/crate_universe_bzlmod.md

First and foremost it paves the way for a meaningful update the Bazelmod
documentation that references these and existing code examples. This
touches at least the following issues:
* #2670
* #2181


The compile_opt example addresses or resolves:
*  #515
* #2701

The musl_cross_compilling example addresses or resolves
* #390 
* #276

The oci_container does not relate to any open issue, 
although the tokio example in it gives a nice end to end example so 
this definitely helps those looking for something non-trivial.

The proto example addresses or resolves:
*  #2668
*  #302
* #2534
* Possibly a few more if I were to search longer

Formalities
* I've signed the CLA
* I've signed all commits

---------

Signed-off-by: Marvin Hansen <marvin.hansen@gmail.com>
Co-authored-by: Daniel Wagner-Hall <dawagner@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants