# [1.1.0](https://git.gitlab.arm.com/bazel/download_utils/compare/v1.0.1...v1.1.0) (2025-06-26)

### Bug Fixes

* add `links` to `{srcs}` replacement ([7cdde03d](https://git.gitlab.arm.com/bazel/download_utils/commit/7cdde03d46f62f4d70076cb829477b02957ac834))
* append canonical arguments to `WORKSPACE` if it exists ([86b169d0](https://git.gitlab.arm.com/bazel/download_utils/commit/86b169d04841489f83c13a64a8b48dd24f0e3fad))
* **archive:** allow empty string for `extension` attribute ([e0fa71ae](https://git.gitlab.arm.com/bazel/download_utils/commit/e0fa71aec075840a59fa179ccc615d125db11049))
* do not write `WORKSPACE` if `metadata` attribute is set ([1dc4fb7f](https://git.gitlab.arm.com/bazel/download_utils/commit/1dc4fb7fc1b7b0e92cdfa4d9693e5df5b17ed4b6))

### Features

* add `download_template` extension ([32479b12](https://git.gitlab.arm.com/bazel/download_utils/commit/32479b12a3a18b97f5b58a1c1ab73fbe3f896a2c))
* add pre-commit hooks ([062cad43](https://git.gitlab.arm.com/bazel/download_utils/commit/062cad437b5d44190594a1365d46586627c8f714))
* allow custom metadata files ([ea05186e](https://git.gitlab.arm.com/bazel/download_utils/commit/ea05186e72848a1dca7348f035989cf40d7ab91c))

```py
download = use_extension("@download_utils//download/template:defs.bzl", "download_template")
download.archive(
    name = "coreutils-{version}-{triplet}",
    srcs = ["entrypoint"],
    links = {
        "coreutils{executable.extension}": "entrypoint",
    },
    lock = "//coreutils:lock.json",
    strip_prefix = "coreutils-{version}-{rust.triplet}",
    substitutions = {
        "version": [
            "0.0.28",
            "0.1.0",
        ],
        "triplet": [
            "arm64-linux-gnu",
            "amd64-linux-gnu",
            "arm64-linux-musl",
            "amd64-linux-musl",
            "amd64-windows-msvc",
            "arm64-macos-darwin",
            "amd64-macos-darwin",
        ],
    },
    uploads = [
        "https://gitlab.arm.com/api/v4/projects/bazel%2Fdownload_utils/packages/generic/coreutils/{version}/{rust.archive.basename}",
    ],
    urls = [
        "https://gitlab.arm.com/api/v4/projects/bazel%2Fdownload_utils/packages/generic/coreutils/{version}/{rust.archive.basename}",
        "https://github.com/uutils/coreutils/releases/download/{version}/coreutils-{version}-{rust.archive.basename}",
    ],
)
```

Run `bazel mod tidy --lockfile_mode=update` to generate the lock file.

Run `bazel run @download_utils//download/triplet/lock:upload coreutils/lock.json` to mirror the downloads and lock the integrities.

Allows easier wrapping of the repository rule as `""` is the default value.

When a link is created within a downloaded repository, it needs to be added to the exported files.

This behaviour can be overridden by settings `srcs` (if available) or overriding the `BUILD.bazel` template with `build`.

```
ERROR: The repo contents cache [/builds/bazel/download_utils/.cache/bazel/repo/contents] is inside the workspace [/builds/bazel/download_utils]. This can cause spurious failures. Disable the repo contents cache with `--repo_contents_cache=`, or specify `--repo_contents_cache=<path outside the workspace>`.
```

When a user is using `metadata` attribute, we do not write anything to `WORKSPACE`.

Eventually, the writing of data to `WORKSPACE` will be removed in a breaking change release.

Previously, the canonical arguments were blatted over any previously existing `WORKSPACE`.

This was stupid. It now appends to the file if it exists.

Eventually, in a breaking change we will remove this functionality as it is superseded by `metadata` attribute.

Jonathan Watson authored Feb 26, 2025 and Matthew Clarkson committed Feb 28, 2025

```py
download_file(
    name = "example",
    metadata = {
        "//:integrity.tmpl.bzl", ".integrity.bzl",
    },
)
```

Where `integrity.tmpl.bzl` is:

```py
visibility("public")

INTEGRITY = "{{integrity}}"
```

Then `@example//:.integrity.bzl"` can be used in `load` statement to read the download integrity.

## [1.0.1](https://git.gitlab.arm.com/bazel/download_utils/compare/v1.0.0...v1.0.1) (2025-02-12)

### Bug Fixes

* upgrade to `toolchain_utils@1.0.2` ([c02f469c](https://git.gitlab.arm.com/bazel/download_utils/commit/c02f469c5c424e183b25368e85a65cea215bc0d9))

Removes a circular dependency. `rules_diff` indirectly depends on `download_utils`.

# 1.0.0 (2025-01-22)

### Bug Fixes

* **commands:** add Bazel 8 `+` separator support ([8f191be6](https://git.gitlab.arm.com/bazel/download_utils/commit/8f191be671e12e9e6485179b27f4b462be4a0a61))
* **commands:** support Bazel 8 naming of `use_repo_rule` ([f1aee877](https://git.gitlab.arm.com/bazel/download_utils/commit/f1aee877e10375658a10b0afe215b62482c03023))
* **e2e:** change to BCR `toolchain_utils` ([4e72ac59](https://git.gitlab.arm.com/bazel/download_utils/commit/4e72ac597ca564cef6dddd5195cb2d09adbacf0e))
* embed download data into `WORKSPACE` to fix cache invalidation ([e475cafa](https://git.gitlab.arm.com/bazel/download_utils/commit/e475cafa5535e39e87b71179bfd36213c9ff365a))
* **rules_download:** make intergrity optional ([24fdc840](https://git.gitlab.arm.com/bazel/download_utils/commit/24fdc840fa1d156219795b6167b4068bcb3a4547))
* **rules_download:** remove need for `http_archive` ([cd6d57c6](https://git.gitlab.arm.com/bazel/download_utils/commit/cd6d57c6039e072920e6845ad1de85c3760372fd))
* scope tool labels to project ([dc65387a](https://git.gitlab.arm.com/bazel/download_utils/commit/dc65387a7394d23278b13e8ff05409d08d9a9fbb))
* set minimum version to Bazel 7 ([62659e41](https://git.gitlab.arm.com/bazel/download_utils/commit/62659e4177e853fb2695f31b4b126f5112906566))
* update dependencies for Bazel 8 support ([eef06717](https://git.gitlab.arm.com/bazel/download_utils/commit/eef0671705d34b6693ca3bf909e2337b5ea8a351))
* update dependencies for Bazel 8 support ([39f37182](https://git.gitlab.arm.com/bazel/download_utils/commit/39f37182454a4d1137d1554f205ad45aa0f616a5))
* upgrade `rules_toolchain` ([8c8b0339](https://git.gitlab.arm.com/bazel/download_utils/commit/8c8b03393a45f7f9a643413cb2095ad4f663b150))
* upgrade to `toolchain_utils@1.0.1` ([8e8498be](https://git.gitlab.arm.com/bazel/download_utils/commit/8e8498be4ae9363c1768661c7423dca72b1f30b1))
* use `rules_license` to define license ([68c1b831](https://git.gitlab.arm.com/bazel/download_utils/commit/68c1b831cbab394253727387eb0e6e68c8e1c0b2))
* use `rules_toolchain` pre-release registry ([f449dcff](https://git.gitlab.arm.com/bazel/download_utils/commit/f449dcff560b61644212f9f2be8406066fe30482))

### Code Refactoring

* change `symlinks` to `links` ([cf1ebd8f](https://git.gitlab.arm.com/bazel/download_utils/commit/cf1ebd8fe1fd0e9cfdf90e9e3ac2504f959d0f51))
* name changed to `download_utils` ([8e583abe](https://git.gitlab.arm.com/bazel/download_utils/commit/8e583abe439ae26d61c34fb9a56397ae7b5b2f2e))

### Features

* add `extension` attribute to `download_archive` ([c476a810](https://git.gitlab.arm.com/bazel/download_utils/commit/c476a8105c623a23996421b68bcbf08c20b6a5ac))
* add `symlinks` attribute to rules ([7d0d27a5](https://git.gitlab.arm.com/bazel/download_utils/commit/7d0d27a5dd4fed84a36285eda4020d6b7003e70e))
* add Windows support ([8934621f](https://git.gitlab.arm.com/bazel/download_utils/commit/8934621f44cf7a44788886917e0795da92d4f922))
* added semantic release to bazel template ([a8a66341](https://git.gitlab.arm.com/bazel/download_utils/commit/a8a663411461dfd66fcc36635b1659a1beb3bd6b))
* remove `coreutils` ([6d3dcccc](https://git.gitlab.arm.com/bazel/download_utils/commit/6d3dccccb46c6d71f10a0b0e92d0b5dec6af4f01))
* rules for downloading ([0ebae87f](https://git.gitlab.arm.com/bazel/download_utils/commit/0ebae87f7901be40f8a157a3ea5f74395f1548be))
* **rules_download:** add `deb` extension ([cd44830e](https://git.gitlab.arm.com/bazel/download_utils/commit/cd44830e04648b5210f00a63548d669688434090))
* **rules_download:** add `file` extension ([bf98fbe8](https://git.gitlab.arm.com/bazel/download_utils/commit/bf98fbe86f1a8e8bfa5ba7d37c5d07f44fd4b716))
* **rules_download:** hermetic `commands` ([51c84b1d](https://git.gitlab.arm.com/bazel/download_utils/commit/51c84b1d2d60c5b5504321a24a04decf500059f9))

### BREAKING CHANGES

* Project renamed to `download_utils` for BCR upstreaming.

A graceful switch can be done by renaming the module in `MODULE.bazel`:

```
bazel_dep(name = "download_utils", repo_name = "rules_download")
```
* `symlinks` in the rule is now `links`

```diff
 download_archive(
-    symlinks = {
+    links = {
         "abc.txt": "def.txt",
     }
 )
```

Removes `reuse` support.

Will be disabled by default in Bazel 9.

We exclusively use `MODULE.bazel`.

Remove legacy workspace.

Bazel resolves transitive versions based on the `compatibility_level` and
can chose a newer version that what is specified in `MODULE.bazel`.

The warnings are often noise as we are happy to use newer versions, we
just specify the minimum version we are compatible with in `MODULE.bazel`.