diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index bc8d424..568ede8 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,4 +1,4 @@ -name: unified-ui CI +name: ui CI on: pull_request: diff --git a/README.md b/README.md index a3a23ea..0bf9308 100644 --- a/README.md +++ b/README.md @@ -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 --- diff --git a/SECURITY.md b/SECURITY.md index 46f615c..bbaf08b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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 diff --git a/docs/releasing.md b/docs/releasing.md index 97d2d55..725816f 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -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 @@ -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. diff --git a/packages/client/package.json b/packages/client/package.json index 0eef9ee..b67d563 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -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", diff --git a/packages/ui/package.json b/packages/ui/package.json index 25234d2..de9369b 100644 --- a/packages/ui/package.json +++ b/packages/ui/package.json @@ -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",