Raven-1/.github/release-notes-template.md
KT 1449a73ee5
docs: refresh the release notes template for resources and plugin wheels (#1026)
## Summary

The release notes template had drifted from what main ships, so the
draft CI
builds for the next tag would carry four stale statements. This brings
the
template, and RELEASING.md which describes it, in line with main.

- Install: `install.sh` now downloads the word dictionary and PDF models
the
knowledge reader uses (#489). `RAVEN_MINIMAL=1` skips them and
`install.ps1`
does not download them, so the section names `raven resources` for both
  cases.
- Install: bare `raven` opens the page where a browser can be opened and
the TUI
only otherwise; the terminal entry is `raven tui`. The v0.2.4 notes
corrected
  this by hand, but the template kept the old sentence.
- Upgrade: the update row at the bottom of the sidebar upgrades a page
served by
  0.2.3 or later. This too was written into the v0.2.4 notes by hand.
- Assets: a release attaches four plugin wheels since #883 added
  `everos_cloud_memory`; the plugin list still installs the other three.

This should merge before the 0.2.5 version bump (#1025), so the drafts
its tags
build start from the corrected template.

Each statement was checked against main:

- `install.sh` runs `raven.resources --optional` unless `RAVEN_MINIMAL`
is set;
  `install.ps1` has no resource step.
- With no subcommand, `raven` opens the page when a browser can be
opened and
  the TUI otherwise (`raven/cli/commands.py`).
- `release.yml` builds the `everos-cloud-memory` wheel beside the other
three
plugin wheels and uploads every wheel, while `raven-plugins.txt` lists
only
  `everos_memory`, `design_engine` and `ppt_engine`.

## Type

- [ ] Fix
- [ ] Feature
- [x] Docs
- [ ] CI / tooling
- [ ] Refactor
- [ ] Other

## Verification

- `sed "s/__VERSION__/9.9.9/g; s/__TAG__/v9.9.9/g"
.github/release-notes-template.md`,
the substitution `release.yml` runs: no placeholder is left, and the
three
  TODO markers the draft keeps for hand-filling are unchanged.
- `PYTHONPATH=. python3 scripts/check_commit_messages.py
origin/main..HEAD`:
  exit 0
- `npx commitlint --from origin/main --to HEAD --config
commitlint.config.cjs`:
  exit 0
- `PYTHONPATH=. python3 scripts/check_large_files.py origin/main..HEAD`
and
`PYTHONPATH=. python3 scripts/check_source_language.py
origin/main..HEAD`:
  exit 0
- No test run: no test reads either file.

- [ ] Relevant tests pass locally
- [x] Relevant lint / type checks pass locally
- [x] User-facing docs or screenshots are updated when needed

## Risk

Docs only. What changes is the Install, Upgrade and Release Status text
of the
next release drafts. Rollback is reverting this commit.

- [ ] Security impact considered
- [x] Backward compatibility considered
- [x] Rollback path is clear for risky changes

## Related Issues

N/A

Co-authored-by: Claude (claude-opus-5-5) <noreply@anthropic.com>
2026-10-20 20:28:53 +08:00

3.6 KiB

Highlights

Install

New install on Linux, macOS, or WSL2:

curl -fsSL https://raven.evermind.ai/install.sh | bash

New install on native Windows, in PowerShell:

irm https://raven.evermind.ai/install.ps1 | iex

Windows PowerShell 5.1 (the version built into Windows) cannot follow that URL's redirect and stops with (308) Permanent Redirect. If you see that error, use the direct one instead:

irm https://raw.githubusercontent.com/EverMind-AI/Raven/refs/heads/main/install.ps1 | iex

The installer puts uv, Node.js 22, Raven and its plugins in place, downloads the browser runtime and the word dictionary and PDF models the knowledge reader uses (about 110 MB), installs or offers LibreOffice, and then finishes by opening Raven in your browser. First-run setup happens on that page. The installer holds the terminal while the page is up; press Ctrl-C to stop it, then start Raven again with:

raven web

That keeps Raven running in the background and opens the page; raven web --stop stops it. Bare raven does the same, and opens the TUI only where no browser can be opened. Prefer the terminal? raven tui runs the same first-run setup and opens the TUI, and raven onboard stays the explicit way to reconfigure later. Set RAVEN_MINIMAL=1 to skip the browser, model and LibreOffice downloads, or RAVEN_NO_LAUNCH=1 to have the installer return without opening the page. The Windows installer does not download the dictionary and models; there, and after RAVEN_MINIMAL=1, raven resources fetches them.

Upgrade

Already running Raven? Upgrade in place -- configuration, sessions, and memory are preserved. On a raven web install whose page is served by 0.2.3 or later, the update row at the bottom of the sidebar does this for you, and the page reloads itself, still signed in, once the new version is up. A page served by 0.2.2 or earlier refuses it; from the command line, stop the page first, then upgrade:

raven web --stop
raven upgrade

On Linux and macOS raven upgrade runs the install in the foreground and returns when it is done. On native Windows it hands the install to a separate helper and returns at once; wait for the helper's completion message. Then start Raven again:

raven web

raven upgrade installs the latest stable release together with the plugin wheels it ships. It never picks up a pre-release unless this install has joined the beta channel (a ~/.raven/beta.json that only the beta installer writes). raven upgrade --check reports whether a newer release exists without installing it. Editable source checkouts are never overwritten: raven upgrade reports the checkout path and how far it is ahead of or behind origin/main, and the remedy is git pull && ./install.sh in the checkout. Rerunning the one-line installer also upgrades, and ends on the running page.

Release Status

  • Version: __VERSION__
  • Tag: __TAG__
  • Stability:
  • Assets: the raven wheel and source distribution, four plugin wheels (everos_memory, everos_cloud_memory, design_engine, ppt_engine), the locked constraints file raven-constraints.txt, and the plugin list raven-plugins.txt, which installs every plugin wheel but everos_cloud_memory

Notes

  • Raven is still pre-1.0; CLI surfaces, plugin contracts, and runtime internals may continue to evolve.
  • PyPI publishing is not enabled yet; the supported public install path uses the GitHub Release wheel asset.