Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hayd/deno-udd

Update Deno Dependencies - update dependency urls to their latest published versions
https://github.com/hayd/deno-udd

Last synced: 19 days ago
JSON representation

Update Deno Dependencies - update dependency urls to their latest published versions

Awesome Lists containing this project

README

        

# Update Deno Dependencies

Run this script to update your dependency urls to their latest published
versions. Optionally run --test(s) to ensure that each dependency update is
non-breaking.

![deno-udd](https://user-images.githubusercontent.com/1931852/76134819-37add280-5fd6-11ea-96c3-adbd57cfa68c.jpg)

![ci-status](https://github.com/hayd/deno-udd/workflows/ci/badge.svg)

Note: udd is **fundamentally different** from something like npm or yarn. Other
tools do a "distributed update" i.e. _every user updates_ independently (and
potentially to untested versions/configurations of dependencies). With udd
precisely _one person updates_ (a maintainer), and they can ensure that the new
dependencies pass the test suite before commiting/releasing a new version. With
udd every user has a fixed version of the dependencies.

[Semantic versioning fragments](https://github.com/hayd/deno-udd#semantic-versioning)
are _purely_ a convenience for the maintainer, and do not affect users.

## Installation

Use deno
[`install`](https://deno.land/std/manual.md#installing-executable-scripts) to
install or update udd:

```sh
deno install -rf --allow-read=. --allow-write=. --allow-net https://deno.land/x/udd/main.ts
```

_You may need to include the deno bin directory in your PATH._

## Usage

For example, to update url imports inside `deps.ts` run:

```sh
udd deps.ts
```

To update all the ts files in your directory:

```sh
udd *.ts
```

To ensure that `deno test` is successful when updating each dependency:

```sh
udd deps.ts --test="deno test"
```

## Scheduled github action

You might like to use a [github action](https://docs.github.com/en/actions) to
execute udd each day, check whether there are dependency updates, and - if there
are - create a pull request to your repository.

![](https://user-images.githubusercontent.com/1931852/140999026-cebd4e9b-768a-4005-8888-2a964bccfe71.png)

As an example see the
[`.github/workflows/udd.yml`](https://github.com/hayd/deno-udd/blob/master/.github/workflows/udd.yml)
file in the udd repository.

_Thanks to [Eliaz Bobadilla](https://github.com/UltiRequiem) for the initial
action implementation._

## Semantic versioning

If you append a fragment `#${token}${version}` to your urls you can manage their
update behavior:

| Token | Name | udd updates to the latest version such that |
| :---- | :------------ | -------------------------------------------------------------: |
| ^ | Compatible | major version is the same (if major=0 then same minor version) |
| ~ | Approximately | major and minor version are the same (or both major=0) |
| < | Less than | less than the provided version |
| = | Equal | it's exactly this version |

The version argument is optional for `^`, `~` and `=` (the version passed is the
version in the url).

### Examples

```diff
-export { Application } from "https://deno.land/x/[email protected]/mod.ts#^";
+export { Application } from "https://deno.land/x/[email protected]/mod.ts#^"; // 3.x.y is not chosen

-export { decode } from "https://deno.land/[email protected]/strings/decode.ts#=";
+export { decode } from "https://deno.land/[email protected]/strings/decode.ts#="; // no change

-export { Application } from "https://deno.land/x/[email protected]/mod.ts#<0.2.0";
+export { Application } from "https://deno.land/x/[email protected]/mod.ts#<0.2.0"; // 0.2.x is not chosen

-export { encode } from "https://deno.land/[email protected]/strings/encode.ts#~";
+export { encode } from "https://deno.land/[email protected]/strings/encode.ts#~"; // update to latest compatible
```

![udd-in-action](https://user-images.githubusercontent.com/1931852/76695958-a1675580-6642-11ea-81d1-9ed15d22965f.gif)

## Supported domains

udd supports the following registry domains:

- https://deno.land/std
- https://deno.land/x
- https://denopkg.com
- https://dev.jspm.io
- https://cdn.pika.dev
- https://cdn.skypack.dev
- https://esm.sh
- https://unpkg.com
- https://raw.githubusercontent.com
- https://gitlab.com/:user/:repo/-/raw
- https://cdn.jsdelivr.net
- https://x.nest.land
- https://pax.deno.dev

_Create an issue to request additional registries._

---

_Logo by [Drake Sauer](http://clipart-library.com/clipart/6ir6AMoKT.htm)._