Back to Bazel

Vendor

docs/versions/8.1.0/rules/lib/globals/vendor.mdx

9.1.02.9 KB
Original Source
<html devsite> <head> <meta name="project_path" value="/_project.yaml"> <meta name="book_path" value="/versions/8.1.0/_book.yaml"> </head> <body> <h1 class="page-title" id="modules.vendor">VENDOR.bazel files</h1>

{% dynamic setvar source_file "NONE" %} {% dynamic setvar version "8.1.0" %} {% dynamic setvar original_path "/rules/lib/globals/vendor" %} {% include "_buttons.html" %}

<!-- {% raw %} -->

Methods available in VENDOR.bazel files.

<h2>Members</h2> <ul> <li> <a href="#ignore">ignore</a> </li> <li> <a href="#pin">pin</a> </li> </ul>
  <h2 id="ignore">ignore</h2>
    <p><pre class="rule-signature"><code>None</code> ignore(*args)</pre></p>

Ignore this repo from vendoring. Bazel will never vendor it or use the corresponding directory (if exists) while building in vendor mode.

      <!-- hide-from-toc is a class used by DevSite for the public Bazel site
  (https://developers.google.com/devsite/reference/styles/headings#hide_headings_from_the_toc) -->
  <h3 class="hide-from-toc">Parameters</h3>
  <table class="table table-bordered table-condensed table-params">
    <colgroup>
      <col class="col-param">
      <col class="param-description">
    </colgroup>
    <thead>
      <tr>
        <th>Parameter</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
              <tr>
        <td id="ignore.args">
          <code>args</code>
        </td>
        <td>
                                 required

                      The canonical repo names of the repos to ignore.
        </td>
      </tr>
            </tbody>
  </table>

    <h2 id="pin">pin</h2>
    <p><pre class="rule-signature"><code>None</code> pin(*args)</pre></p>

Pin the contents of this repo under the vendor directory. Bazel will not update this repo while vendoring, and will use the vendored source as if there is a --override_repository flag when building in vendor mode

      <!-- hide-from-toc is a class used by DevSite for the public Bazel site
  (https://developers.google.com/devsite/reference/styles/headings#hide_headings_from_the_toc) -->
  <h3 class="hide-from-toc">Parameters</h3>
  <table class="table table-bordered table-condensed table-params">
    <colgroup>
      <col class="col-param">
      <col class="param-description">
    </colgroup>
    <thead>
      <tr>
        <th>Parameter</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
              <tr>
        <td id="pin.args">
          <code>args</code>
        </td>
        <td>
                                 required

                      The canonical repo names of the repos to pin.
        </td>
      </tr>
            </tbody>
  </table>
</body> </html> <!-- {% endraw %} -->