57_WolveandClaude Opus 5
e5a5ab2317
build / build (push) Successful in 7m9s
Rebase the de-brand + dark-theme series onto upstream v1.8.0 and make it the highest entry in the support matrix. v1.8.0 adds an IAM section to the admin UI — iam.html, iam-users.html, iam-roles.html, iam-oidc.html and js/iam-ui.js — and rewrites much of the existing pages, so the series needed real work rather than a clean replay: * Sidebar conflict (buckets/dashboard/explorer/users). Upstream inserted an "Identity & Access" nav group exactly where the de-brand patch deletes the "Resources" block, so all four pages conflicted. Resolved by keeping the new IAM nav and dropping Resources, along with the divider that only existed to separate the two — matching the original patch, which likewise left no trailing rule at the end of the nav. * The four new IAM pages carry full Versity branding and were not covered by the old series. Extended the de-brand patch to give them the same treatment: tab title, favicon, sidebar wordmark, page heading, and removal of the Resources links. The OIDC client-ID placeholder sts.versity.local becomes sts.example.local, matching the neutral token.example.com placeholder upstream already uses in that same form. * Dark theme needed one new rule. Audited every color utility in the new IAM markup against the override layer: all were already covered except group-hover:bg-gray-200 on the IAM overview cards' icon chip, which would flash near-white on card hover. Added it next to the existing hover:bg-gray-200 override. Left alone deliberately: internal JS identifiers and code comments (class VersityAPI, "Maximum parts allowed by VersityGW"), which are not visible branding and which the series has never touched; and the per-file Apache-2.0 headers, kept for license compliance. The series touches webui/ only — 961 files after apply, which is v1.8.0's 959 plus favicon.svg and four font files, less the three Versity PNGs. Verified: ci/clone-source.sh + ci/apply-patches.sh apply the exported series to a pristine v1.8.0 with no 3-way fallback, producing a tree byte-identical to the one developed here, and ./cmd/versitygw (the goreleaser target) builds clean from it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
169 lines
6.9 KiB
Markdown
169 lines
6.9 KiB
Markdown
# s3-gateway
|
||
|
||
Downstream build pipeline that produces **de-branded
|
||
[versitygw](https://github.com/versity/versitygw) releases** — the
|
||
upstream Versity S3 Gateway with Versity trademarks and logos removed
|
||
from the admin web UI.
|
||
|
||
Same pattern as [`scoutfs-build`](../scoutfs-build): pull an upstream
|
||
release **tag**, apply our **patch series** scoped to that tag, build
|
||
with upstream's GoReleaser, and publish to **Gitea Releases**.
|
||
|
||
Artifact names are intentionally **unchanged** — the binary stays
|
||
`versitygw` and the deb/rpm packages stay `versitygw`, so builds are
|
||
drop-in compatible with existing configs, systemd units, and the
|
||
`versitygw` CLI. Only the embedded web UI is rebranded to "S3 Gateway".
|
||
|
||
```
|
||
upstream tag (vX.Y.Z) this repo
|
||
github.com/versity/versitygw patches/<tag>/*.patch
|
||
│ │
|
||
▼ ▼
|
||
ci/clone-source.sh ───► ci/apply-patches.sh ───► ci/build.sh ───► ci/publish-release.sh
|
||
(shallow clone tag) (git am --3way) (goreleaser) (Gitea release assets)
|
||
```
|
||
|
||
`ci/support-matrix.yaml` records which upstream versions have a curated
|
||
patch set and maps each to its patch directory.
|
||
|
||
## Layout
|
||
|
||
```
|
||
s3-gateway/
|
||
├── ci/
|
||
│ ├── support-matrix.yaml # upstream tag -> patch directory (registry)
|
||
│ ├── clone-source.sh # shallow-clone upstream versitygw at a tag
|
||
│ ├── apply-patches.sh # git am --3way patches/<tag>/*.patch
|
||
│ ├── build.sh # goreleaser release (binaries + deb/rpm)
|
||
│ ├── publish-release.sh # upload dist/* to a Gitea release
|
||
│ └── run.sh # local end-to-end: clone + patch + build one tag
|
||
├── patches/
|
||
│ ├── v1.6.0/
|
||
│ │ ├── 0001-webui-debrand.patch
|
||
│ │ └── 0002-webui-dark-theme.patch
|
||
│ └── v1.5.0/
|
||
│ └── 0001-webui-debrand.patch
|
||
├── .gitea/workflows/build.yml
|
||
└── docs/multi-version-pipeline.md
|
||
```
|
||
|
||
## Build locally
|
||
|
||
Prerequisites: `git`, `go`, and [`goreleaser`](https://goreleaser.com).
|
||
|
||
```bash
|
||
# Build one upstream tag end-to-end → artifacts in src/dist/
|
||
VGW_TAG=v1.5.0 bash ci/run.sh
|
||
|
||
# Fast offline build against a local upstream clone:
|
||
VGW_REPO_URL="/path/to/versitygw" VGW_TAG=v1.5.0 bash ci/run.sh
|
||
```
|
||
|
||
Or run the steps individually:
|
||
|
||
```bash
|
||
VGW_TAG=v1.5.0 bash ci/clone-source.sh # → src/
|
||
VGW_TAG=v1.5.0 bash ci/apply-patches.sh # git am the series onto src/
|
||
VGW_TAG=v1.5.0 bash ci/build.sh # goreleaser → src/dist/
|
||
```
|
||
|
||
`src/` and `src/dist/` are gitignored.
|
||
|
||
## Patches
|
||
|
||
Patch sets live in `patches/<dir>/` as `git format-patch` files and are
|
||
applied with `git am --3way`, in filename order. The directory for a
|
||
tag comes from the `patches:` field in `ci/support-matrix.yaml`
|
||
(defaults to the tag name).
|
||
|
||
Currently maintained:
|
||
|
||
| Upstream tag | Patch set | Contents |
|
||
|--------------|---------------|-----------------------------------------------------------|
|
||
| `v1.8.0` | `v1.8.0/` | `0001-webui-debrand.patch`, `0002-webui-dark-theme.patch` |
|
||
| `v1.7.0` | `v1.7.0/` | `0001-webui-debrand.patch`, `0002-webui-dark-theme.patch` |
|
||
| `v1.6.0` | `v1.6.0/` | `0001-webui-debrand.patch`, `0002-webui-dark-theme.patch` |
|
||
| `v1.5.0` | `v1.5.0/` | `0001-webui-debrand.patch` |
|
||
|
||
### What the de-brand patch does
|
||
|
||
- Sidebar/login logos → a plain **"S3 Gateway"** wordmark.
|
||
- Page titles: "VersityGW Dashboard" → "Dashboard" (Buckets, Users,
|
||
Explorer and the v1.8.0 IAM pages too).
|
||
- Browser tab titles → "S3 Gateway – …".
|
||
- Removes the sidebar **Resources** section (external `github.com/versity` links).
|
||
- Replaces the Versity favicon with a neutral SVG; deletes the Versity logo PNGs.
|
||
- Removes the visible "© Versity Software Inc." footer from the login page.
|
||
|
||
Deliberately **kept** (license compliance): the per-file Apache-2.0
|
||
license headers — which carry the upstream copyright notice as an HTML
|
||
comment at the top of each file — and the `NOTICE` file. Upstream is
|
||
Apache-2.0; the de-brand strips the visible Versity *trademarks* (logos,
|
||
wordmarks, and the login footer) while preserving the *copyright* notice
|
||
in the source headers.
|
||
|
||
### What the dark-theme patch does
|
||
|
||
`0002-webui-dark-theme.patch` re-skins the admin UI to match the
|
||
**kanrisha** web app — a near-black palette with indigo/blue accents —
|
||
without touching the page markup. It works entirely through the two
|
||
shared asset files plus bundled fonts:
|
||
|
||
- `tailwind-config.js` — remaps the named color tokens (`surface`,
|
||
`charcoal`, `primary`, `accent`) onto the dark palette and switches
|
||
the sans/mono fonts to Inter / JetBrains Mono.
|
||
- `theme.css` — sets the dark body, restyles the bespoke components
|
||
(sidebar active state, dropdowns, toggles, checkboxes, file rows,
|
||
login) in indigo, and adds an override layer that flips the built-in
|
||
Tailwind white/gray/status utilities the markup uses.
|
||
- `fonts.css` + `assets/fonts/*.woff2` — self-hosts Inter and JetBrains
|
||
Mono (variable, latin + latin-ext) so the UI stays fully offline,
|
||
matching the existing self-hosted Roboto.
|
||
|
||
The only markup change is the login page's light background gradient,
|
||
which becomes a solid dark surface. Currently applied to `v1.6.0`,
|
||
`v1.7.0` and `v1.8.0`.
|
||
|
||
## Adding / refreshing a version
|
||
|
||
When upstream cuts a new release you want a build of, you rebase the
|
||
patch series onto it and add a patch directory. See
|
||
[docs/multi-version-pipeline.md](docs/multi-version-pipeline.md) for the
|
||
full recipe. In short:
|
||
|
||
```bash
|
||
# Rebase the series onto the new tag, re-export into patches/vX.Y.Z/
|
||
git clone https://github.com/versity/versitygw && cd versitygw
|
||
git -c core.autocrlf=false checkout -b debrand vX.Y.Z
|
||
git am --3way /path/to/s3-gateway/patches/<prev>/*.patch # resolve any conflicts
|
||
git format-patch --binary vX.Y.Z..HEAD -o /path/to/s3-gateway/patches/vX.Y.Z/
|
||
```
|
||
|
||
Then add the tag to `ci/support-matrix.yaml`, commit, and build it (see
|
||
below).
|
||
|
||
## CI
|
||
|
||
`.gitea/workflows/build.yml` builds **one version per run** and
|
||
publishes it to a Gitea release in this repo. It triggers two ways — no
|
||
scheduled/cron builds:
|
||
|
||
- **By new tag** — push a `vX.Y.Z` tag to this repo; CI builds upstream
|
||
versitygw `vX.Y.Z` with `patches/vX.Y.Z/`.
|
||
- **One-shot** — run the **build** workflow manually (workflow_dispatch)
|
||
and enter the upstream tag to build.
|
||
|
||
Configuration:
|
||
|
||
- **Runner**: any Linux runner (`runs-on: ubuntu-latest`). The Go
|
||
toolchain comes from the `golang` container, so the runner only needs
|
||
Docker.
|
||
- **Secret**: `TOKEN_GITEA` — a Gitea PAT with **write:repository**
|
||
(clones this repo + creates releases / uploads assets).
|
||
- **Variable (optional)**: `VGW_REPO_URL` to override the upstream URL.
|
||
|
||
## License
|
||
|
||
Apache-2.0, matching versitygw upstream. Upstream copyright and
|
||
`NOTICE` are retained in every build.
|