Repository navigation
Making a Release
This page is a short guide for maintainers who cut an OpenBridge release. The source of truth is
docs/RELEASING.md; if this page and that file disagree,
the file wins.
Releases are built by GitHub Actions with one button. Nothing goes to a package or container registry: every download is attached to the GitHub Release itself.
-
mainlineis green in CI. -
CHANGELOG.mdlists the changes under## [Unreleased]. - You have permission to run workflows in the repository.
- Move the
Unreleasedentries inCHANGELOG.mdunder a new heading## [<version>] - <YYYY-MM-DD>, and merge that change. - On GitHub, open Actions, then Release, then Run workflow.
- Enter the version, for example
0.2.0. It must be semantic (1.2.3or1.2.3-beta.1) and not already tagged, or the workflow stops. - Leave pre-release on while any state adapter is
draft(today, all of them are). - Leave draft on so you can check the release before it goes public.
- Wait for the workflow. It runs
npm run verifyandnpm run e2e, builds the hosted and local versions, builds amd64 and arm64 container images, writes checksums, and creates releasev<version>. - Open the draft release, check the notes and files, and press Publish.
| Download | For |
|---|---|
openbridge-local-v<version>.zip |
One person on one computer: unzip and open OpenBridge.html
|
openbridge-hosted-v<version>.tar.gz |
Organizations hosting it: the static site plus Dockerfile, compose.yaml, nginx and Caddy examples, and serve.mjs
|
openbridge-image-v<version>-linux-amd64.tar.gz and -linux-arm64.tar.gz
|
Hosts who use containers |
SHA256SUMS.txt |
Checksums for every file |
Each download includes BUILD-INFO.json with the version, the rules dataVersion, the review
status of each state adapter, and the commit it was built from.
npm ci
npm run build
npm run build:local -w @openbridge/web-app
npm run release:package -- --version 0.2.0 # writes release-artifacts/- Semantic Versioning. Before 1.0, a minor version may include breaking changes.
- A release that only changes reference data (rule values, federal tables, test cases) bumps the patch version. See Yearly data updates.
- Keep releases marked pre-release until experts have signed off the adapters in
docs/SME_SIGNOFF.md.
OpenBridge is a prototype. Its rules are drafts that experts have not verified yet, and results are
estimates, not decisions. It is not legal advice. Need help applying for benefits? Call 211 or visit
211.org. This wiki is edited in the wiki/ folder of the repository.
Questions: openbridge@starlingtek.com.
Start here
Use OpenBridge
- Using OpenBridge
- Understanding your results
- Guide for navigators
- Privacy and your data
- Run it on your computer
- Host it for others
- Use it with an AI assistant
Help without code
- Ways to help
- Review rules as an expert
- Record a test case
- Report a rule problem
- Translate OpenBridge
- Test accessibility
- Community rule toolkit
Rules and policy (with code)
- How the rules engine works
- State adapters
- Add or change a rule
- Add a new state
- Golden test cases
- Yearly data updates
Developers