Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: unified-ui CI
name: ui CI

on:
pull_request:
Expand Down
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
# Unified UI
# UI

[![unified-ui CI](https://github.com/OpusProjects/unified-ui/actions/workflows/ci.yaml/badge.svg)](https://github.com/OpusProjects/unified-ui/actions/workflows/ci.yaml)
[![ui CI](https://github.com/OpusProjects/ui/actions/workflows/ci.yaml/badge.svg)](https://github.com/OpusProjects/ui/actions/workflows/ci.yaml)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![React](https://img.shields.io/badge/react-19-61dafb.svg?logo=react)](https://react.dev/)
[![TypeScript](https://img.shields.io/badge/typescript-7.0-3178c6.svg?logo=typescript)](https://www.typescriptlang.org/)

The web UIs for [unified-api](https://github.com/OpusProjects/unified-api) and
[unified-gitops](https://github.com/OpusProjects/unified-gitops), and the shared packages they are
built from.
A web UI library and the apps built from it, written in TypeScript.

Each tool serves its own UI on its own address: open it in a browser, sign in, and see what it
holds and whether it is keeping up. The UIs read the same REST API any other consumer uses and
keep no state of their own, and both are built from the same packages, so they look alike.
Each app is served by its service on the service's own address: open it in a browser, sign in, and
see what the service holds and whether it is keeping up. The apps read the same REST API any other
consumer uses and keep no state of their own, and all are built from the same packages, so they look alike.

---

## ✨ Features

- **One look, every tool**: the shell, menu, search, tables, cards and charts live in shared packages
- **One look, every app**: the shell, menu, search, tables, cards and charts live in shared packages
- **Thin apps**: each app passes only its own words and data; the shared pieces do the rest
- **Typed from the API**: each app's client is generated from its tool's OpenAPI spec
- **No state of its own**: everything shown comes from the tool's REST API, read live
- **Signs in through the tool**: API keys or LDAP accounts, sessions and CSRF on every write
- **Typed from the API**: each app's client is generated from its service's OpenAPI spec
- **No state of its own**: everything shown comes from the service's REST API, read live
- **Signs in through the service**: API keys or LDAP accounts, sessions and CSRF on every write
- **Permissions respected**: a restricted key sees only what it may; admin pages leave the menu
- **Light and dark**: follows the system, or a choice remembered in this browser
- **Search anywhere**: `/` or Ctrl+K finds configured items by name, then the tool's own objects
- **Search anywhere**: `/` or Ctrl+K finds configured items by name, then the service's own objects
- **Live metrics**: charts sampled from `/metrics` while the app is open, the last half hour
- **Pinned per release**: each tool builds a tagged version into its image, nothing to deploy apart
- **Pinned per release**: each service builds a tagged version into its image, nothing to deploy apart
- **Tested end to end**: Playwright against each app's mocked API, on every pull request

---
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Only the latest release line receives security fixes.
Please **do not open a public issue** for security problems.

Use GitHub's private vulnerability reporting instead:
[Report a vulnerability](https://github.com/OpusProjects/unified-ui/security/advisories/new)
[Report a vulnerability](https://github.com/OpusProjects/ui/security/advisories/new)
— it opens a private thread with the maintainers.

Include what you can: affected page or component, reproduction steps, and
Expand Down
6 changes: 3 additions & 3 deletions docs/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ feature PR ──squash──▶ main ──▶ release-please updates the open
same workflow then runs CI on it (see [below](#when-the-release-pr-has-no-checks)).
4. **Merging it is the release.** Squash-merge it once its checks are green; the
workflow then creates the tag `vX.Y.Z` and the GitHub Release titled `vX.Y.Z`, with the CHANGELOG
section as its notes. unified-ui publishes no image of its own.
section as its notes. The ui repository publishes no image of its own.

Never create a tag or a GitHub Release by hand: the next release PR would not
know about it, and a hand-made release is authored by a person rather than the
Expand Down Expand Up @@ -145,9 +145,9 @@ gh workflow run ci.yaml --ref release-please--branches--main

## How unified-api and unified-gitops pick it up

unified-ui is versioned on its own; each tool builds a pinned unified-ui version into its image.
ui is versioned on its own; each tool builds a pinned ui version into its image.

That pin is `UI_REF` in the tool's `docker/Dockerfile`. A new unified-ui release
That pin is `UI_REF` in the tool's `docker/Dockerfile`. A new ui release
reaches users when a unified-api or unified-gitops release bumps that pin in a
`build:` pull request, so a UI change that needs a newer API route ships
together with the API that has it.
2 changes: 1 addition & 1 deletion packages/client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "https://github.com/OpusProjects/unified-ui.git",
"url": "https://github.com/OpusProjects/ui.git",
"directory": "packages/client"
},
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "https://github.com/OpusProjects/unified-ui.git",
"url": "https://github.com/OpusProjects/ui.git",
"directory": "packages/ui"
},
"type": "module",
Expand Down
Loading