Check for updates

Let Xaden tell you when a newer Xaden or newer dependencies exist, as often as you choose. Xaden only reports. It never installs or changes anything because of what it finds.

The check is off until you turn it on. While it is off, Xaden makes no network call for it.

Turn it on for a project

Add one line to xaden/xaden.conf and review it in a pull request like any other setting:

update-check = 1d

• update-check = off: no check. This is the default.
• update-check = 12h, 1d, 7d: at most one check per interval. The interval is a whole number of hours (h) or days (d), at least 1h. Anything else (30m, 1w, 1.5d) is refused and the message names the allowed forms.

xaden create and xaden adopt ask for the interval once when a terminal is attached. The default answer is off. Without a terminal they set nothing.

Turn it on for yourself only

export XADEN_UPDATE_CHECK=7d

• XADEN_UPDATE_CHECK: takes the same values and overrides the project value on your machine. The repository does not change.

Look now

xaden update-check

• xaden update-check: checks now, whatever the interval, and prints the result. While the setting is off it refuses; add --now to look anyway.
• xaden update-check --if-due: checks only when the interval has passed, prints nothing and exits 0 when the network is down.

What it reports

Xaden: pinned 0.2.3, installed 0.2.3, newest 0.3.0 (move the project with: xaden upgrade 0.3.0)
Dependencies: npm: left-pad; pip: up to date

• The Xaden line compares the version the project pins with the newest release on github.com. Move the project with xaden upgrade, on a branch and through a pull request (Pin one Xaden version per project).
• The Dependencies line lists packages that npm outdated or pip list --outdated report for the project. Those updates stay yours: xaden upgrade never touches package.json, lockfiles or requirements-dev.txt.
• A tool that is not installed shows as not checked, never as up to date.

The result is cached in the repository’s git folder (.git/xaden-update-check), so it is never committed and every worktree shares it. xaden doctor and scripts/context-status.sh print the cached result and the setting in effect (update check: 1d (xaden/xaden.conf)). They, the commit hooks and the pre-commit checks never use the network.

What is sent

One request for the newest release goes to the GitHub release API, the same one xaden upgrade --check uses. npm outdated and pip list --outdated contact the registries your project already uses. Nothing else leaves your machine.

Projects created with xaden create --classic have no xaden/xaden.conf; use XADEN_UPDATE_CHECK there.