Awesome
<!-- Generated with Stardoc: http://skydoc.bazel.build --><a id="assemble_crate"></a>
assemble_crate
<pre> assemble_crate(<a href="#assemble_crate-name">name</a>, <a href="#assemble_crate-authors">authors</a>, <a href="#assemble_crate-categories">categories</a>, <a href="#assemble_crate-crate_features">crate_features</a>, <a href="#assemble_crate-description">description</a>, <a href="#assemble_crate-documentation">documentation</a>, <a href="#assemble_crate-homepage">homepage</a>, <a href="#assemble_crate-keywords">keywords</a>, <a href="#assemble_crate-license">license</a>, <a href="#assemble_crate-license_file">license_file</a>, <a href="#assemble_crate-readme_file">readme_file</a>, <a href="#assemble_crate-repository">repository</a>, <a href="#assemble_crate-target">target</a>, <a href="#assemble_crate-universe_manifests">universe_manifests</a>, <a href="#assemble_crate-version_file">version_file</a>, <a href="#assemble_crate-workspace_refs">workspace_refs</a>) </pre>ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="assemble_crate-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="assemble_crate-authors"></a>authors | Project authors | List of strings | optional | <code>[]</code> |
| <a id="assemble_crate-categories"></a>categories | Project categories | List of strings | optional | <code>[]</code> |
| <a id="assemble_crate-crate_features"></a>crate_features | Available features in the crate, in format similar to the cargo features format. | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> List of strings</a> | optional | <code>{}</code> |
| <a id="assemble_crate-description"></a>description | The description is a short blurb about the package. crates.io will display this with your package. This should be plain text (not Markdown). https://doc.rust-lang.org/cargo/reference/manifest.html#the-description-field | String | required | |
| <a id="assemble_crate-documentation"></a>documentation | Link to documentation of the project | String | optional | <code>""</code> |
| <a id="assemble_crate-homepage"></a>homepage | Link to homepage of the project | String | required | |
| <a id="assemble_crate-keywords"></a>keywords | The keywords field is an array of strings that describe this package. This can help when searching for the package on a registry, and you may choose any words that would help someone find this crate.<br><br> Note: crates.io has a maximum of 5 keywords. Each keyword must be ASCII text, start with a letter, and only contain letters, numbers, _ or -, and have at most 20 characters.<br><br> https://doc.rust-lang.org/cargo/reference/manifest.html#the-keywords-field | List of strings | optional | <code>[]</code> |
| <a id="assemble_crate-license"></a>license | The license field contains the name of the software license that the package is released under. https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields | String | required | |
| <a id="assemble_crate-license_file"></a>license_file | License file for the crate. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="assemble_crate-readme_file"></a>readme_file | README of the project | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="assemble_crate-repository"></a>repository | Repository of the project | String | required | |
| <a id="assemble_crate-target"></a>target | <code>rust_library</code> label to be included in the package | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="assemble_crate-universe_manifests"></a>universe_manifests | The Cargo manifests used by crates_universe to generate Bazel targets for crates.io dependencies.<br><br> These manifests serve as the source of truth for emitting dependency configuration in the assembled crate, such as explicitly requested features and the exact version requirement. | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | <code>[]</code> |
| <a id="assemble_crate-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0' | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="assemble_crate-workspace_refs"></a>workspace_refs | JSON file describing dependencies to other Bazel workspaces | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="assemble_maven"></a>
assemble_maven
<pre> assemble_maven(<a href="#assemble_maven-name">name</a>, <a href="#assemble_maven-developers">developers</a>, <a href="#assemble_maven-license">license</a>, <a href="#assemble_maven-platform_overrides">platform_overrides</a>, <a href="#assemble_maven-project_description">project_description</a>, <a href="#assemble_maven-project_name">project_name</a>, <a href="#assemble_maven-project_url">project_url</a>, <a href="#assemble_maven-scm_url">scm_url</a>, <a href="#assemble_maven-target">target</a>, <a href="#assemble_maven-version_file">version_file</a>, <a href="#assemble_maven-version_overrides">version_overrides</a>, <a href="#assemble_maven-workspace_refs">workspace_refs</a>) </pre>Assemble Java package for subsequent deployment to Maven repo
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="assemble_maven-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="assemble_maven-developers"></a>developers | Project developers to fill into pom.xml | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> List of strings</a> | optional | <code>{}</code> |
| <a id="assemble_maven-license"></a>license | Project license to fill into pom.xml | String | optional | <code>"apache"</code> |
| <a id="assemble_maven-platform_overrides"></a>platform_overrides | Per-platform overrides for a dependency. Expects a dict of bazel labels to a JSON-encoded list of maven coordinates. Ex.: assemble_maven( ... platform_overrides = { ":bazel-dependency": json.encode([ "org.company:dependency-windows-x86_64:{pom_version}", "org.company:dependency-linux-aarch64:{pom_version}", "org.company:dependency-linux-x86_64:{pom_version}", "org.company:dependency-macosx-aarch64:{pom_version}", "org.company:dependency-macosx-x86_64:{pom_version}", ]) } ) | <a href="https://bazel.build/rules/lib/dict">Dictionary: Label -> String</a> | optional | <code>{}</code> |
| <a id="assemble_maven-project_description"></a>project_description | Project description to fill into pom.xml | String | optional | <code>"PROJECT_DESCRIPTION"</code> |
| <a id="assemble_maven-project_name"></a>project_name | Project name to fill into pom.xml | String | optional | <code>"PROJECT_NAME"</code> |
| <a id="assemble_maven-project_url"></a>project_url | Project URL to fill into pom.xml | String | optional | <code>"PROJECT_URL"</code> |
| <a id="assemble_maven-scm_url"></a>scm_url | Project source control URL to fill into pom.xml | String | optional | <code>"PROJECT_URL"</code> |
| <a id="assemble_maven-target"></a>target | Java target for subsequent deployment | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="assemble_maven-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0' | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="assemble_maven-version_overrides"></a>version_overrides | Dictionary of maven artifact : version to pin artifact versions to | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | <code>{}</code> |
| <a id="assemble_maven-workspace_refs"></a>workspace_refs | JSON file describing dependencies to other Bazel workspaces | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="assemble_npm"></a>
assemble_npm
<pre> assemble_npm(<a href="#assemble_npm-name">name</a>, <a href="#assemble_npm-target">target</a>, <a href="#assemble_npm-version_file">version_file</a>) </pre>Assemble npm_package target for further deployment. Currently does not support remote execution (RBE).
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="assemble_npm-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="assemble_npm-target"></a>target | <code>npm_library</code> label to be included in the package. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="assemble_npm-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0'. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="assemble_pip"></a>
assemble_pip
<pre> assemble_pip(<a href="#assemble_pip-name">name</a>, <a href="#assemble_pip-author">author</a>, <a href="#assemble_pip-author_email">author_email</a>, <a href="#assemble_pip-classifiers">classifiers</a>, <a href="#assemble_pip-description">description</a>, <a href="#assemble_pip-keywords">keywords</a>, <a href="#assemble_pip-license">license</a>, <a href="#assemble_pip-long_description_file">long_description_file</a>, <a href="#assemble_pip-package_name">package_name</a>, <a href="#assemble_pip-python_requires">python_requires</a>, <a href="#assemble_pip-requirements_file">requirements_file</a>, <a href="#assemble_pip-suffix">suffix</a>, <a href="#assemble_pip-target">target</a>, <a href="#assemble_pip-url">url</a>, <a href="#assemble_pip-version_file">version_file</a>) </pre>ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="assemble_pip-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="assemble_pip-author"></a>author | Details about the author | String | required | |
| <a id="assemble_pip-author_email"></a>author_email | The email for the author | String | required | |
| <a id="assemble_pip-classifiers"></a>classifiers | A list of strings, containing Python package classifiers | List of strings | required | |
| <a id="assemble_pip-description"></a>description | A string with the short description of the package | String | required | |
| <a id="assemble_pip-keywords"></a>keywords | A list of strings, containing keywords | List of strings | required | |
| <a id="assemble_pip-license"></a>license | The type of license to use | String | required | |
| <a id="assemble_pip-long_description_file"></a>long_description_file | A label with the long description of the package. Usually a README or README.rst file | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="assemble_pip-package_name"></a>package_name | A string with Python pip package name | String | required | |
| <a id="assemble_pip-python_requires"></a>python_requires | If your project only runs on certain Python versions, setting the python_requires argument to the appropriate PEP 440 version specifier string will prevent pip from installing the project on other Python versions. | String | optional | <code>">0"</code> |
| <a id="assemble_pip-requirements_file"></a>requirements_file | A file with the list of required packages for this one | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="assemble_pip-suffix"></a>suffix | A suffix that has to be removed from the filenames | String | optional | <code>""</code> |
| <a id="assemble_pip-target"></a>target | <code>py_library</code> label to be included in the package | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="assemble_pip-url"></a>url | A homepage for the project | String | required | |
| <a id="assemble_pip-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0' | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="assemble_versioned"></a>
assemble_versioned
<pre> assemble_versioned(<a href="#assemble_versioned-name">name</a>, <a href="#assemble_versioned-targets">targets</a>, <a href="#assemble_versioned-version_file">version_file</a>) </pre>Version multiple archives for subsequent simultaneous deployment
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="assemble_versioned-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="assemble_versioned-targets"></a>targets | Archives to version and put into output archive | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | <code>[]</code> |
| <a id="assemble_versioned-version_file"></a>version_file | File containing version string | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="checksum"></a>
checksum
<pre> checksum(<a href="#checksum-name">name</a>, <a href="#checksum-archive">archive</a>) </pre>Computes SHA256 checksum of file
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="checksum-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="checksum-archive"></a>archive | Archive to compute checksum of | <a href="https://bazel.build/concepts/labels">Label</a> | required |
<a id="deploy_apt"></a>
deploy_apt
<pre> deploy_apt(<a href="#deploy_apt-name">name</a>, <a href="#deploy_apt-release">release</a>, <a href="#deploy_apt-snapshot">snapshot</a>, <a href="#deploy_apt-target">target</a>) </pre>Deploy package built with assemble_apt to APT repository.
Select deployment to `snapshot` or `release` repository with `bazel run //:some-deploy-apt -- [snapshot|release]
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="deploy_apt-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="deploy_apt-release"></a>release | Release repository to deploy apt artifact to | String | required | |
| <a id="deploy_apt-snapshot"></a>snapshot | Snapshot repository to deploy apt artifact to | String | required | |
| <a id="deploy_apt-target"></a>target | assemble_apt label to deploy | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="deploy_brew"></a>
deploy_brew
<pre> deploy_brew(<a href="#deploy_brew-name">name</a>, <a href="#deploy_brew-file_substitutions">file_substitutions</a>, <a href="#deploy_brew-formula">formula</a>, <a href="#deploy_brew-release">release</a>, <a href="#deploy_brew-snapshot">snapshot</a>, <a href="#deploy_brew-type">type</a>, <a href="#deploy_brew-version_file">version_file</a>) </pre>Deploy Homebrew (Caskroom) formula to Homebrew tap.
Select deployment to `snapshot` or `release` repository with `bazel run //:some-deploy-brew -- [snapshot|release]
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="deploy_brew-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="deploy_brew-file_substitutions"></a>file_substitutions | Substitute file contents into the formula. Key: file to read the substitution from. Value: placeholder in the formula template to substitute. | <a href="https://bazel.build/rules/lib/dict">Dictionary: Label -> String</a> | optional | <code>{}</code> |
| <a id="deploy_brew-formula"></a>formula | The brew formula definition | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="deploy_brew-release"></a>release | Release repository to deploy brew artifact to | String | required | |
| <a id="deploy_brew-snapshot"></a>snapshot | Snapshot repository to deploy brew artifact to | String | required | |
| <a id="deploy_brew-type"></a>type | Type of deployment (Homebrew/Caskroom). Cask is generally used for graphic applications | String | optional | <code>"brew"</code> |
| <a id="deploy_brew-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0' | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="deploy_crate"></a>
deploy_crate
<pre> deploy_crate(<a href="#deploy_crate-name">name</a>, <a href="#deploy_crate-release">release</a>, <a href="#deploy_crate-snapshot">snapshot</a>, <a href="#deploy_crate-target">target</a>) </pre>Deploy assemble_crate target into Crate repo
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="deploy_crate-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="deploy_crate-release"></a>release | Release repository to release Crate artifact to | String | required | |
| <a id="deploy_crate-snapshot"></a>snapshot | Snapshot repository to release Crate artifact to | String | required | |
| <a id="deploy_crate-target"></a>target | assemble_crate target to deploy | <a href="https://bazel.build/concepts/labels">Label</a> | required |
<a id="deploy_github"></a>
deploy_github
<pre> deploy_github(<a href="#deploy_github-name">name</a>, <a href="#deploy_github-archive">archive</a>, <a href="#deploy_github-draft">draft</a>, <a href="#deploy_github-organisation">organisation</a>, <a href="#deploy_github-release_description">release_description</a>, <a href="#deploy_github-repository">repository</a>, <a href="#deploy_github-title">title</a>, <a href="#deploy_github-title_append_version">title_append_version</a>, <a href="#deploy_github-version_file">version_file</a>) </pre>Deploy assemble_versioned target to GitHub Releases
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="deploy_github-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="deploy_github-archive"></a>archive | <code>assemble_versioned</code> label to be deployed. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="deploy_github-draft"></a>draft | Creates an unpublished / draft release when set to True. Defaults to True. | Boolean | optional | <code>True</code> |
| <a id="deploy_github-organisation"></a>organisation | Github organisation to deploy to | String | required | |
| <a id="deploy_github-release_description"></a>release_description | Description of GitHub release | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="deploy_github-repository"></a>repository | Github repository to deploy to within organisation | String | required | |
| <a id="deploy_github-title"></a>title | Title of GitHub release | String | optional | <code>""</code> |
| <a id="deploy_github-title_append_version"></a>title_append_version | Append version to GitHub release title | Boolean | optional | <code>False</code> |
| <a id="deploy_github-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0' | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="deploy_npm"></a>
deploy_npm
<pre> deploy_npm(<a href="#deploy_npm-name">name</a>, <a href="#deploy_npm-release">release</a>, <a href="#deploy_npm-snapshot">snapshot</a>, <a href="#deploy_npm-target">target</a>) </pre>Deploy `assemble_npm` target into npm registry using token authentication.
Select deployment to `snapshot` or `release` repository with `bazel run //:some-deploy-npm -- [snapshot|release]
## How to generate an auth token
### Using the command line (`npm adduser`)
1. Run `npm adduser <repo_url>` (example: `npm adduser --registry=https://npm.cloudsmith.io/typedb/private/`)
2. When prompted, provide login credentials to sign in to the user account that is used in your CI and has permissions to publish the package
3. If successful, a line will be added to your `.npmrc` file (`$HOME/.npmrc` on Unix) which looks like: `//npm.cloudsmith.io/typedb/private/:_authToken=NpmToken.00000000-0000-0000-0000-000000000000`. The token is the value of `_authToken`, in this case `NpmToken.00000000-0000-0000-0000-000000000000`.
4. Save the auth token somewhere safe and then delete it from your `.npmrc` file
### Using a UI
Some remote repository managers (e.g. the `npm` registry, https://npmjs.com) provide a UI to create auth tokens.
#### `npm` registry (`npmjs.com`)
1. Sign in to the user account at https://npmjs.com that is used in your CI and has permissions to publish the package
2. Navigate to the account's "Access Tokens", generate a new one and store it somewhere safe
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="deploy_npm-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="deploy_npm-release"></a>release | Release repository to deploy npm artifact to. | String | required | |
| <a id="deploy_npm-snapshot"></a>snapshot | Snapshot repository to deploy npm artifact to. | String | required | |
| <a id="deploy_npm-target"></a>target | <code>assemble_npm</code> target to be included in the package. | <a href="https://bazel.build/concepts/labels">Label</a> | required |
<a id="deploy_packer"></a>
deploy_packer
<pre> deploy_packer(<a href="#deploy_packer-name">name</a>, <a href="#deploy_packer-overwrite">overwrite</a>, <a href="#deploy_packer-target">target</a>) </pre>Execute Packer to perform deployment
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="deploy_packer-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="deploy_packer-overwrite"></a>overwrite | Overwrite already-existing image | Boolean | optional | <code>False</code> |
| <a id="deploy_packer-target"></a>target | <code>assemble_packer</code> label to be deployed. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="doxygen_docs"></a>
doxygen_docs
<pre> doxygen_docs(<a href="#doxygen_docs-name">name</a>, <a href="#doxygen_docs-desc">desc</a>, <a href="#doxygen_docs-main_page_md">main_page_md</a>, <a href="#doxygen_docs-project_name">project_name</a>, <a href="#doxygen_docs-sources">sources</a>, <a href="#doxygen_docs-strip_prefix">strip_prefix</a>, <a href="#doxygen_docs-version">version</a>) </pre> Creates HTML documentation for C++ projects using Doxygen.
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="doxygen_docs-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="doxygen_docs-desc"></a>desc | A description for the project | String | optional | <code>""</code> |
| <a id="doxygen_docs-main_page_md"></a>main_page_md | The file to use as main page for the generate docs | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="doxygen_docs-project_name"></a>project_name | The project name for the doxygen docs | String | required | |
| <a id="doxygen_docs-sources"></a>sources | A list of files made available to doxygen. This is NOT automatically included in the doxyfile | <a href="https://bazel.build/concepts/labels">List of labels</a> | required | |
| <a id="doxygen_docs-strip_prefix"></a>strip_prefix | Prefix to strip from path of files being processed | String | optional | <code>""</code> |
| <a id="doxygen_docs-version"></a>version | The version of the project being documented | String | optional | <code>""</code> |
<a id="generate_json_config"></a>
generate_json_config
<pre> generate_json_config(<a href="#generate_json_config-name">name</a>, <a href="#generate_json_config-substitutions">substitutions</a>, <a href="#generate_json_config-template">template</a>) </pre>Fills in JSON template with provided values
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="generate_json_config-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="generate_json_config-substitutions"></a>substitutions | Values to fill in | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | <code>{}</code> |
| <a id="generate_json_config-template"></a>template | JSON template to fill in values | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="java_deps"></a>
java_deps
<pre> java_deps(<a href="#java_deps-name">name</a>, <a href="#java_deps-allowed_conflicting_jars">allowed_conflicting_jars</a>, <a href="#java_deps-ignore_missing_maven_name">ignore_missing_maven_name</a>, <a href="#java_deps-java_deps_root">java_deps_root</a>, <a href="#java_deps-java_deps_root_overrides">java_deps_root_overrides</a>, <a href="#java_deps-maven_name">maven_name</a>, <a href="#java_deps-target">target</a>, <a href="#java_deps-version_file">version_file</a>) </pre>Packs Java library alongside with its dependencies into archive
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="java_deps-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="java_deps-allowed_conflicting_jars"></a>allowed_conflicting_jars | List of allowed JAR names that can conflict (ie. the same JAR name produced by two different dependencies). | List of strings | optional | <code>[]</code> |
| <a id="java_deps-ignore_missing_maven_name"></a>ignore_missing_maven_name | Don't fail if bundling using maven names when encountering a target that is missing a maven name | Boolean | optional | <code>False</code> |
| <a id="java_deps-java_deps_root"></a>java_deps_root | Folder inside archive to put JARs into | String | optional | <code>""</code> |
| <a id="java_deps-java_deps_root_overrides"></a>java_deps_root_overrides | JARs with filenames matching the given patterns will be placed into the specified folders inside the archive, instead of the default folder. Patterns can be either the full name of a JAR, or a prefix followed by a '*'. | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | <code>{}</code> |
| <a id="java_deps-maven_name"></a>maven_name | Name JAR files inside archive based on Maven coordinates | Boolean | optional | <code>False</code> |
| <a id="java_deps-target"></a>target | Java target to pack into archive | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="java_deps-version_file"></a>version_file | File containing version string. Alternatively, pass --define version=VERSION to Bazel invocation. Not specifying version at all defaults to '0.0.0' | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
<a id="sphinx_docs"></a>
sphinx_docs
<pre> sphinx_docs(<a href="#sphinx_docs-name">name</a>, <a href="#sphinx_docs-out">out</a>, <a href="#sphinx_docs-package_subdir">package_subdir</a>, <a href="#sphinx_docs-sphinx_conf">sphinx_conf</a>, <a href="#sphinx_docs-sphinx_rst">sphinx_rst</a>, <a href="#sphinx_docs-target">target</a>) </pre> Creates an HTML documentation for python module using Sphinx.
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="sphinx_docs-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="sphinx_docs-out"></a>out | Output directory | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="sphinx_docs-package_subdir"></a>package_subdir | Directory with the module files in the package archive | String | required | |
| <a id="sphinx_docs-sphinx_conf"></a>sphinx_conf | Configuration file for the Sphinx documentation builder | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="sphinx_docs-sphinx_rst"></a>sphinx_rst | Sphinx documentation master file for the package | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="sphinx_docs-target"></a>target | Package including .tar.gz archive | <a href="https://bazel.build/concepts/labels">Label</a> | required |
<a id="tgz2zip"></a>
tgz2zip
<pre> tgz2zip(<a href="#tgz2zip-name">name</a>, <a href="#tgz2zip-output_filename">output_filename</a>, <a href="#tgz2zip-tgz">tgz</a>) </pre>Converts .tar.gz into .zip
ATTRIBUTES
| Name | Description | Type | Mandatory | Default |
|---|---|---|---|---|
| <a id="tgz2zip-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="tgz2zip-output_filename"></a>output_filename | Resulting filename | String | required | |
| <a id="tgz2zip-tgz"></a>tgz | Input .tar.gz archive | <a href="https://bazel.build/concepts/labels">Label</a> | required |
<a id="JarToMavenCoordinatesMapping"></a>
JarToMavenCoordinatesMapping
<pre> JarToMavenCoordinatesMapping(<a href="#JarToMavenCoordinatesMapping-filename">filename</a>, <a href="#JarToMavenCoordinatesMapping-maven_coordinates">maven_coordinates</a>) </pre>FIELDS
| Name | Description |
|---|---|
| <a id="JarToMavenCoordinatesMapping-filename"></a>filename | jar filename |
| <a id="JarToMavenCoordinatesMapping-maven_coordinates"></a>maven_coordinates | Maven coordinates of the jar |
<a id="MavenDeploymentInfo"></a>
MavenDeploymentInfo
<pre> MavenDeploymentInfo(<a href="#MavenDeploymentInfo-jar">jar</a>, <a href="#MavenDeploymentInfo-srcjar">srcjar</a>, <a href="#MavenDeploymentInfo-pom">pom</a>) </pre>FIELDS
| Name | Description |
|---|---|
| <a id="MavenDeploymentInfo-jar"></a>jar | JAR file to deploy |
| <a id="MavenDeploymentInfo-srcjar"></a>srcjar | JAR file with sources |
| <a id="MavenDeploymentInfo-pom"></a>pom | Accompanying pom.xml file |
<a id="TransitiveJarToMavenCoordinatesMapping"></a>
TransitiveJarToMavenCoordinatesMapping
<pre> TransitiveJarToMavenCoordinatesMapping(<a href="#TransitiveJarToMavenCoordinatesMapping-mapping">mapping</a>) </pre>FIELDS
| Name | Description |
|---|---|
| <a id="TransitiveJarToMavenCoordinatesMapping-mapping"></a>mapping | maps jar filename to coordinates |
<a id="assemble_apt"></a>
assemble_apt
<pre> assemble_apt(<a href="#assemble_apt-name">name</a>, <a href="#assemble_apt-package_name">package_name</a>, <a href="#assemble_apt-maintainer">maintainer</a>, <a href="#assemble_apt-description">description</a>, <a href="#assemble_apt-version_file">version_file</a>, <a href="#assemble_apt-installation_dir">installation_dir</a>, <a href="#assemble_apt-workspace_refs">workspace_refs</a>, <a href="#assemble_apt-archives">archives</a>, <a href="#assemble_apt-empty_dirs">empty_dirs</a>, <a href="#assemble_apt-empty_dirs_permission">empty_dirs_permission</a>, <a href="#assemble_apt-files">files</a>, <a href="#assemble_apt-depends">depends</a>, <a href="#assemble_apt-symlinks">symlinks</a>, <a href="#assemble_apt-permissions">permissions</a>, <a href="#assemble_apt-architecture">architecture</a>, <a href="#assemble_apt-target_compatible_with">target_compatible_with</a>) </pre>Assemble package for installation with APT
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_apt-name"></a>name | A unique name for this target. | none |
| <a id="assemble_apt-package_name"></a>package_name | Package name for built .deb package https://www.debian.org/doc/debian-policy/ch-controlfields#package | none |
| <a id="assemble_apt-maintainer"></a>maintainer | The package maintainer's name and email address. The name must come first, then the email address inside angle brackets <> (in RFC822 format) | none |
| <a id="assemble_apt-description"></a>description | description of the built package https://www.debian.org/doc/debian-policy/ch-controlfields#description | none |
| <a id="assemble_apt-version_file"></a>version_file | File containing version number of a package. Alternatively, pass --define version=VERSION to Bazel invocation. Specifying commit SHA will result in prepending '0.0.0' to it to comply with Debian rules. Not specifying version at all defaults to '0.0.0' https://www.debian.org/doc/debian-policy/ch-controlfields#version | <code>None</code> |
| <a id="assemble_apt-installation_dir"></a>installation_dir | directory into which .deb package is unpacked at installation | <code>None</code> |
| <a id="assemble_apt-workspace_refs"></a>workspace_refs | JSON file with other Bazel workspace references | <code>None</code> |
| <a id="assemble_apt-archives"></a>archives | Bazel labels of archives that go into .deb package | <code>[]</code> |
| <a id="assemble_apt-empty_dirs"></a>empty_dirs | list of empty directories created at package installation | <code>[]</code> |
| <a id="assemble_apt-empty_dirs_permission"></a>empty_dirs_permission | UNIXy permission for the empty directories to be created | <code>"0777"</code> |
| <a id="assemble_apt-files"></a>files | mapping between Bazel labels of archives that go into .deb package and their resulting location on .deb package installation | <code>{}</code> |
| <a id="assemble_apt-depends"></a>depends | list of Debian packages this package depends on https://www.debian.org/doc/debian-policy/ch-relationships.htm | <code>[]</code> |
| <a id="assemble_apt-symlinks"></a>symlinks | mapping between source and target of symbolic links created at installation | <code>{}</code> |
| <a id="assemble_apt-permissions"></a>permissions | mapping between paths and UNIXy permissions | <code>{}</code> |
| <a id="assemble_apt-architecture"></a>architecture | package architecture (default option: 'all', common other options: 'amd64', 'arm64') | <code>"all"</code> |
| <a id="assemble_apt-target_compatible_with"></a>target_compatible_with | <p align="center"> - </p> | <code>[]</code> |
<a id="assemble_aws"></a>
assemble_aws
<pre> assemble_aws(<a href="#assemble_aws-name">name</a>, <a href="#assemble_aws-ami_name">ami_name</a>, <a href="#assemble_aws-install">install</a>, <a href="#assemble_aws-region">region</a>, <a href="#assemble_aws-files">files</a>) </pre>Assemble files for AWS deployment
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_aws-name"></a>name | A unique name for this target. | none |
| <a id="assemble_aws-ami_name"></a>ami_name | AMI name of deployed image | none |
| <a id="assemble_aws-install"></a>install | Bazel label for install file | none |
| <a id="assemble_aws-region"></a>region | AWS region to deploy image to | none |
| <a id="assemble_aws-files"></a>files | Files to include into AWS deployment | none |
<a id="assemble_azure"></a>
assemble_azure
<pre> assemble_azure(<a href="#assemble_azure-name">name</a>, <a href="#assemble_azure-image_name">image_name</a>, <a href="#assemble_azure-resource_group_name">resource_group_name</a>, <a href="#assemble_azure-install">install</a>, <a href="#assemble_azure-image_publisher">image_publisher</a>, <a href="#assemble_azure-image_offer">image_offer</a>, <a href="#assemble_azure-image_sku">image_sku</a>, <a href="#assemble_azure-disk_size_gb">disk_size_gb</a>, <a href="#assemble_azure-files">files</a>) </pre>Assemble files for Azure deployment
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_azure-name"></a>name | A unique name for this target. | none |
| <a id="assemble_azure-image_name"></a>image_name | name of deployed image | none |
| <a id="assemble_azure-resource_group_name"></a>resource_group_name | name of the resource group to place image in | none |
| <a id="assemble_azure-install"></a>install | Bazel label for install file | none |
| <a id="assemble_azure-image_publisher"></a>image_publisher | Publisher of the image used as base | <code>"Canonical"</code> |
| <a id="assemble_azure-image_offer"></a>image_offer | Offer of the image used as base | <code>"0001-com-ubuntu-server-focal"</code> |
| <a id="assemble_azure-image_sku"></a>image_sku | SKU of the image used as base | <code>"20_04-lts"</code> |
| <a id="assemble_azure-disk_size_gb"></a>disk_size_gb | Size of the resulting OS disk | <code>60</code> |
| <a id="assemble_azure-files"></a>files | Files to include into Azure deployment | <code>None</code> |
<a id="assemble_gcp"></a>
assemble_gcp
<pre> assemble_gcp(<a href="#assemble_gcp-name">name</a>, <a href="#assemble_gcp-project_id">project_id</a>, <a href="#assemble_gcp-install">install</a>, <a href="#assemble_gcp-zone">zone</a>, <a href="#assemble_gcp-image_name">image_name</a>, <a href="#assemble_gcp-image_family">image_family</a>, <a href="#assemble_gcp-files">files</a>, <a href="#assemble_gcp-image_licenses">image_licenses</a>, <a href="#assemble_gcp-disable_default_service_account">disable_default_service_account</a>, <a href="#assemble_gcp-source_image_family">source_image_family</a>) </pre>Assemble files for GCP deployment
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_gcp-name"></a>name | A unique name for this target. | none |
| <a id="assemble_gcp-project_id"></a>project_id | Google project id | none |
| <a id="assemble_gcp-install"></a>install | Bazel label for install file | none |
| <a id="assemble_gcp-zone"></a>zone | GCP zone to deploy image to | none |
| <a id="assemble_gcp-image_name"></a>image_name | name of deployed image | none |
| <a id="assemble_gcp-image_family"></a>image_family | family of deployed image | <code>""</code> |
| <a id="assemble_gcp-files"></a>files | Files to include into GCP deployment | <code>None</code> |
| <a id="assemble_gcp-image_licenses"></a>image_licenses | licenses to attach to deployed image | <code>None</code> |
| <a id="assemble_gcp-disable_default_service_account"></a>disable_default_service_account | disable default service account | <code>False</code> |
| <a id="assemble_gcp-source_image_family"></a>source_image_family | Family of GCP base image | <code>"ubuntu-1604-lts"</code> |
<a id="assemble_packer"></a>
assemble_packer
<pre> assemble_packer(<a href="#assemble_packer-name">name</a>, <a href="#assemble_packer-config">config</a>, <a href="#assemble_packer-files">files</a>) </pre>Assemble files for HashiCorp Packer deployment
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_packer-name"></a>name | A unique name for this target. | none |
| <a id="assemble_packer-config"></a>config | Packer JSON config | none |
| <a id="assemble_packer-files"></a>files | Files to include into deployment | <code>{}</code> |
<a id="assemble_targz"></a>
assemble_targz
<pre> assemble_targz(<a href="#assemble_targz-name">name</a>, <a href="#assemble_targz-output_filename">output_filename</a>, <a href="#assemble_targz-targets">targets</a>, <a href="#assemble_targz-additional_files">additional_files</a>, <a href="#assemble_targz-empty_directories">empty_directories</a>, <a href="#assemble_targz-permissions">permissions</a>, <a href="#assemble_targz-append_version">append_version</a>, <a href="#assemble_targz-visibility">visibility</a>, <a href="#assemble_targz-tags">tags</a>, <a href="#assemble_targz-target_compatible_with">target_compatible_with</a>) </pre>Assemble distribution archive (.tar.gz)
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_targz-name"></a>name | A unique name for this target. | none |
| <a id="assemble_targz-output_filename"></a>output_filename | filename of resulting archive | <code>None</code> |
| <a id="assemble_targz-targets"></a>targets | Bazel labels of archives that go into .tar.gz package | <code>[]</code> |
| <a id="assemble_targz-additional_files"></a>additional_files | mapping between Bazel labels of files that go into archive and their resulting location in archive | <code>{}</code> |
| <a id="assemble_targz-empty_directories"></a>empty_directories | list of empty directories created at archive installation | <code>[]</code> |
| <a id="assemble_targz-permissions"></a>permissions | mapping between paths and UNIX permissions | <code>{}</code> |
| <a id="assemble_targz-append_version"></a>append_version | append version to root folder inside the archive | <code>True</code> |
| <a id="assemble_targz-visibility"></a>visibility | controls whether the target can be used by other packages | <code>["//visibility:private"]</code> |
| <a id="assemble_targz-tags"></a>tags | <p align="center"> - </p> | <code>[]</code> |
| <a id="assemble_targz-target_compatible_with"></a>target_compatible_with | <p align="center"> - </p> | <code>[]</code> |
<a id="assemble_zip"></a>
assemble_zip
<pre> assemble_zip(<a href="#assemble_zip-name">name</a>, <a href="#assemble_zip-output_filename">output_filename</a>, <a href="#assemble_zip-targets">targets</a>, <a href="#assemble_zip-additional_files">additional_files</a>, <a href="#assemble_zip-empty_directories">empty_directories</a>, <a href="#assemble_zip-permissions">permissions</a>, <a href="#assemble_zip-append_version">append_version</a>, <a href="#assemble_zip-visibility">visibility</a>, <a href="#assemble_zip-tags">tags</a>, <a href="#assemble_zip-target_compatible_with">target_compatible_with</a>) </pre>Assemble distribution archive (.zip)
PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="assemble_zip-name"></a>name | A unique name for this target. | none |
| <a id="assemble_zip-output_filename"></a>output_filename | filename of resulting archive | none |
| <a id="assemble_zip-targets"></a>targets | Bazel labels of archives that go into .tar.gz package | <code>[]</code> |
| <a id="assemble_zip-additional_files"></a>additional_files | mapping between Bazel labels of files that go into archive and their resulting location in archive | <code>{}</code> |
| <a id="assemble_zip-empty_directories"></a>empty_directories | list of empty directories created at archive installation | <code>[]</code> |
| <a id="assemble_zip-permissions"></a>permissions | mapping between paths and UNIX permissions | <code>{}</code> |
| <a id="assemble_zip-append_version"></a>append_version | append version to root folder inside the archive | <code>True</code> |
| <a id="assemble_zip-visibility"></a>visibility | controls whether the target can be used by other packages | <code>["//visibility:private"]</code> |
| <a id="assemble_zip-tags"></a>tags | <p align="center"> - </p> | <code>[]</code> |
| <a id="assemble_zip-target_compatible_with"></a>target_compatible_with | <p align="center"> - </p> | <code>[]</code> |
<a id="deploy_maven"></a>
deploy_maven
<pre> deploy_maven(<a href="#deploy_maven-name">name</a>, <a href="#deploy_maven-target">target</a>, <a href="#deploy_maven-snapshot">snapshot</a>, <a href="#deploy_maven-release">release</a>, <a href="#deploy_maven-kwargs">kwargs</a>) </pre>PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="deploy_maven-name"></a>name | <p align="center"> - </p> | none |
| <a id="deploy_maven-target"></a>target | <p align="center"> - </p> | none |
| <a id="deploy_maven-snapshot"></a>snapshot | <p align="center"> - </p> | none |
| <a id="deploy_maven-release"></a>release | <p align="center"> - </p> | none |
| <a id="deploy_maven-kwargs"></a>kwargs | <p align="center"> - </p> | none |
<a id="deploy_pip"></a>
deploy_pip
<pre> deploy_pip(<a href="#deploy_pip-name">name</a>, <a href="#deploy_pip-target">target</a>, <a href="#deploy_pip-snapshot">snapshot</a>, <a href="#deploy_pip-release">release</a>, <a href="#deploy_pip-suffix">suffix</a>, <a href="#deploy_pip-distribution_tag">distribution_tag</a>) </pre>PARAMETERS
| Name | Description | Default Value |
|---|---|---|
| <a id="deploy_pip-name"></a>name | <p align="center"> - </p> | none |
| <a id="deploy_pip-target"></a>target | <p align="center"> - </p> | none |
| <a id="deploy_pip-snapshot"></a>snapshot | <p align="center"> - </p> | none |
| <a id="deploy_pip-release"></a>release | <p align="center"> - </p> | none |
| <a id="deploy_pip-suffix"></a>suffix | <p align="center"> - </p> | <code>""</code> |
| <a id="deploy_pip-distribution_tag"></a>distribution_tag | <p align="center"> - </p> | <code>"py3-none-any"</code> |