chore(release): website updates for v1.0.0#105
Merged
Conversation
Run RELEASE_CHECKLIST for the Plugwerk 1.0.0 stable release. Phase 1 (OpenAPI sync, PR #102) and Phase 2 (Compose mirror — diff is empty against upstream dist/docker-compose.yml@v1.0.0) were already in main before this PR. Manual phases done in this PR: - src/content/docs/server/deployment.mdx: bump the hardcoded pre-release example tag from 1.0.0-beta.2 to 1.0.0-beta.3 in both the Code block and the tag-strategy table. The current-version slot via pwVersion now resolves to 1.0.0 automatically. - src/pages/index.astro: bump the release banner to v1.0.0 — version, release URL, docker tag, and migration URL. - src/content/docs/releases/1.0.0.mdx (new): release-notes page for the first stable release. Highlights cover the S3 object storage backend, the admin scheduler dashboard, the orphan-artifact reaper, the storage/DB consistency check, operator-uploadable branding (top bar / login / favicon), the effective-config admin view, the general.site_name UI wiring, and the security fast-fail when the encryption key cannot decrypt stored OIDC client secrets at startup. Breaking change called out: PlugwerkUpdateChecker now takes a typed InstalledPluginRef (was Map<String, String>) — the dedicated SDK reference doc update is a separate follow-up. Frontmatter sets `slug: releases/1.0.0` to bypass Starlight's filename-based dot-stripping. - src/content/docs/releases/index.mdx: prepend the new row to the Released versions table. Verification: - npm run format clean - npm run format:check clean - npm run build clean (32 pages built; new release page renders at /releases/1.0.0/ with the upgrade-notes anchor; banner link resolves correctly) - AGENTS.md ADR/internal-link grep returns 0 hits in newly added content (the pre-existing plugwerk#365 reference in client-sdk/configuration.mdx is the documented exception "upstream PR closing a stale snippet" and is out of scope here) Closes #104
This was referenced May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #104.
Release sweep for Plugwerk v1.0.0 — the first stable release. Follows
RELEASE_CHECKLIST.md.Phase status
mainbefore this PR was opened (public/api-docs/openapi.yaml, +712 / −0, pure additive).public/deploy/docker-compose.ymlmatchesplugwerk-server/.../src/dist/docker-compose.yml@v1.0.0byte-for-byte.server/deployment.mdxexample tag bumped from1.0.0-beta.2to1.0.0-beta.3in two places.src/pages/index.astroupdated toversion: "1.0.0". The banner showsRELEASE / 1.0.0.src/content/docs/releases/1.0.0.mdx(new),releases/index.mdxtable extended.1.0.0created and assigned. Beta.3 milestone closes once PR #93 merges.What's in the release notes
User-facing summary (full content in the new MDX page):
plugwerk.*with secrets redacted)general.site_namewired through the UIPLUGWERK_AUTH_ENCRYPTION_KEYcannot decrypt stored OIDC client secretsBreaking change called out:
PlugwerkUpdateChecker.checkForUpdates(...)now takes a typedInstalledPluginRef(wasMap<String, String>). Existing snippets inclient-sdk/configuration.mdxandclient-sdk/migration.mdxwill become stale — see follow-ups below.Follow-ups (NOT in this PR — track separately)
These are listed in #104 and are intentionally out of scope so this PR stays the release sweep:
InstalledPluginRef— mirror of docs: update SDK reference for PlugwerkInstaller PluginManager-lifecycle SPI (plugwerk#424) #83 / PR docs(client-sdk): document installer load+start lifecycle and uninstall (#83) #92 for thePlugwerkInstallerrework. ExistingMap.of(...)snippets inclient-sdk/configuration.mdx(Usage Examples block) andclient-sdk/migration.mdxneed migration.PLUGWERK_STORAGE_*family, exact names from the synced OpenAPI /.env.example) deserve their own section inserver/configuration.mdx, analog to how the SSRF guard got one in docs(server): document the OIDC SSRF guard env vars (#88) #93.Test plan
npm run formatcleannpm run format:checkcleannpm run buildclean (32 pages built; 1 new release page)RELEASE / 1.0.0and themigrationUrlresolves to/releases/1.0.0/#upgrade-notesslug: releases/1.0.0frontmatter override works (/releases/1.0.0/not/releases/100/)npm run dev, visit/, verify the banner readsRELEASE / 1.0.0in both themes with three working links/releases/1.0.0/, verify Highlights / Breaking changes / Upgrade notes / Other notable changes sections render/releases/, verify the new row appears at the top of the table/server/deployment/, verify the example tag now reads1.0.0-beta.3