<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>crate_universe/DEVELOPMENT.md - fork/rules_rust @ 0.6.0</title>
<meta name="description" content="crate_universe/DEVELOPMENT.md in fork/rules_rust at 0.6.0.">
<meta property="og:title" content="crate_universe/DEVELOPMENT.md - fork/rules_rust @ 0.6.0">
<meta property="og:description" content="crate_universe/DEVELOPMENT.md in fork/rules_rust at 0.6.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="0.6.0" data-tip="91466fc0d102b1754d39d0e9e2cffdb48e7671d0">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">UebelAndre</span><span class="commit-message" data-commit="edca1d80425581aa0122e36f64e4e27690098bd7">Add developing notes for crate_universe (#1351)</span><span class="snapshot-sha sha" data-commit="edca1d80425581aa0122e36f64e4e27690098bd7">edca1d80</span><time datetime="2022-05-23T07:39:57-07:00" title="2022-05-23 07:39:57 -0700">2022-05-23</time></p>
<header class="topbar"><details class="switcher"><summary>0.6.0</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a class="current" href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/0.6.0/tree/crate_universe/">crate_universe</a> / <span class="cur">DEVELOPMENT.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>33 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/7109112c516007a6203e46b3178fba462ab4dca8/crate_universe/DEVELOPMENT.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Developing crate_universe</h1>
<h2>Bootstrapping</h2>
<p>Crate Universe repository rules are backed by a binary called <code>cargo-bazel</code>.
This can be built using cargo by simply changing directories to
<code>@rules_rust//crate_universe</code> and running the following:</p>
<pre class="language-bash"><a-f>cargo</a-f> build <a-co>--bin=cargo-bazel</a-co></pre>
<p>It's then recommended to export the <code>CARGO_BAZEL_GENERATOR_URL</code> environment
variable to be a <code>file://</code> url to the built binary on disk.</p>
<pre class="language-bash"><a-k>export</a-k> <a-pr>CARGO_BAZEL_GENERATOR_URL</a-pr>=<a-eb>$(</a-eb><a-f>pwd</a-f><a-eb>)</a-eb>/target/debug/cargo-bazel</pre>
<p>From here on, the repository rule can be run</p>
<h2>Using non-release rules_rust</h2>
<p>If a project does not get <code>rules_rust</code> from a release artifact from the Github
releases page (e.g. using an archive from a commit or branch) then <code>cargo-bazel</code>
binaries will have to manually be specified for repository rules that consume it.
It's highly recommended to build <code>cargo-bazel</code> binaries yourself and host them
somewhere the project can safely access them. Without this, repository rules will
attempt to build the binary using <a href="https://bazelbuild.github.io/rules_rust/cargo.html#cargo_bootstrap_repository">cargo_bootstrap_repository</a> as a fallback.
This is very time consuming and in no way the recommended workflow for anything
other than developing <code>rules_rust</code> directly.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Developing crate_universe</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>##</a-p> <a-tt>Bootstrapping</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Crate Universe repository rules are backed by a binary called `cargo-bazel`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">This can be built using cargo by simply changing directories to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">`@rules_rust//crate_universe` and running the following:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>cargo build --bin=cargo-bazel</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>It&#39;s then recommended to export the `CARGO_BAZEL_GENERATOR_URL` environment</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>variable to be a `file://` url to the built binary on disk.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>```</a-p><a-tl>shell</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>export CARGO_BAZEL_GENERATOR_URL=$(pwd)/target/debug/cargo-bazel</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>From here on, the repository rule can be run</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>## </a-p><a-tt>Using non-release rules_rust</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>If a project does not get `rules_rust` from a release artifact from the Github</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>releases page (e.g. using an archive from a commit or branch) then `cargo-bazel`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>binaries will have to manually be specified for repository rules that consume it.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>It&#39;s highly recommended to build `cargo-bazel` binaries yourself and host them</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>somewhere the project can safely access them. Without this, repository rules will</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>attempt to build the binary using [cargo_bootstrap_repository][cbr] as a fallback.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>This is very time consuming and in no way the recommended workflow for anything</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>other than developing `rules_rust` directly.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-tu>[cbr]</a-tu><a-p>: </a-p><a-tu>https://bazelbuild.github.io/rules_rust/cargo.html#cargo_bootstrap_repository</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
