Release of the admin with a preview of its packages (A-47)

オープン
#3,464 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
csharp

調査の方向性

Start with docs/planning/admin-technical-spec.md sections 2.8, 6 and 10.8, then trace the named release workflow, admin options, hosting package project and release documentation. The acceptance checklist defines completion across package publishing, default hosting behavior, API checks, version constraints, startup reporting and documentation; the issue says this work depends on every other A7 issue and includes maintainer-controlled release steps.

索引モデルが issue の本文から書いたものです。

説明

area:admin area:build type:chore

Problem

Every release builds the admin and holds it back, in four places:

  • The packages. The Publish workflow packs every package and then removes FluentCMS.Admin* before anything is pushed, with the note "A-47 removes this step" (.github/workflows/publish.yml, lines 205 to 208). The pattern does not match the halves, FluentCMS.Plugins.*.Admin, which is a fault of its own until this issue (see the notes of the milestone).
  • The image. FluentCms:Admin:Enabled is false unless set (admin/src/FluentCMS.Admin.Hosting/AdminOptions.cs, lines 13 and 14), so the image serves no admin until an operator turns it on. Section 6.1 has A-47 make it true.
  • The words. The README says the admin is not part of the preview (line 20), and docs/releasing.md that the admin packages are left out of a release (line 38).
  • The static build is attached to no release (A-43 adds it).

Three things are open about what is released:

  • Which packages promise what. FluentCMS.Admin.Abstractions and FluentCMS.Admin.Components track their public surface (section 2.8). FluentCMS.Admin and FluentCMS.Admin.Hosting have the entry points a team's Program.cs calls (AddFluentCmsAdmin, AdminApp, AddAdmin, MapFluentCmsAdmin, AdminOptions) and no public API file. Row 11.11 asks for a published policy.
  • The hosting package reads Core's internals. FluentCMS.Core names FluentCMS.Admin.Hosting in InternalsVisibleTo (src/FluentCMS.Core/FluentCMS.Core.csproj, line 37), and the package uses at least six internal types of Core (FluentCmsSurfaceMetadata, FluentCmsEndpointMetadata, ContentSecurityPolicyMetadata, ApiPipelineState, HostErrorCodes, FluentCmsOptions), so it works with the one build of Core it was compiled with and fails at run time with another (#3178).
  • A client the host configures itself is not checked. With a secret, or without the scopes, the host starts and config.json still lists the five scopes, so the sign-in fails in the browser with no word from the host (#3178). On by default, every operator who configured that client meets it.

Proposal

  • The release pushes the admin. The step that removes the packages goes; the twelve admin packages (FluentCMS.Admin, .Abstractions, .Components, .RichText, .Administration, .Hosting and the six halves) are pushed with their symbols, and the zip of A-43 is attached. eng/check-packages.cs already checks them in the Pack job.
  • On by default. FluentCms:Admin:Enabled is true unless set to false. docs/docker.md, docs/host-configuration.md, .env.example and the notes say how to turn it off and what it needs (FluentCms:PublicOrigin, https), and the lines that turn it on in the Compose job and in the end-to-end harness go.
  • The promise. FluentCMS.Admin and FluentCMS.Admin.Hosting get the public API analyzer and their two files, with every entry unshipped, as a preview keeps them. docs/releasing.md lists the admin packages in each step that names packages, and says which carry the promise of row 11.11 (the contract and the wrapped set), what AdminRange and the manifest version give a half built for one minor, and that the other packages are a preview without one.
  • The hosting package and Core. Until Core has a public seam (see the notes of the milestone), the package depends on the exact version of FluentCMS.Core it was built with, so that a mismatch is refused at restore and not met at run time.
  • A configured client is named at start. While the admin is on, a client fluentcms-admin that has a secret, or lacks a scope or the redirect URI of the served admin, is reported in the startup report with what is missing. No new refusal in a preview.
  • The notes and the README. The notes of the release that is open when A7 ends get the section of the admin: the three distributions, how to turn it off, the packages as a preview, the supported browsers, English alone, the exceptions of the audit (A-42) and what is known to be missing. The README shows how to open /admin.
  • A rehearsal. A manual run of Publish lists the admin packages and the zip. After the tag, Compose and the end-to-end job of A-45 are run by hand with the published image.

Acceptance

  • A dry run of Publish lists the twelve admin packages with their symbols and fluentcms-admin-{version}.zip, and no step leaves a package out
  • The image with nothing set about the admin serves it at /admin, and FluentCms__Admin__Enabled=false answers 404 there and registers no client
  • FluentCMS.Admin and FluentCMS.Admin.Hosting fail the build on a public member that is in neither of their files
  • The packed FluentCMS.Admin.Hosting depends on FluentCMS.Core at its exact version
  • A configured client fluentcms-admin with a secret is named in the startup report
  • docs/releasing.md, the README and the notes of the release say what ships, and the first two no longer say that the admin is held back
  • The Fresh machine jobs pass with the admin packages from the feed
  • The items of #3178 on the public seam and on the configured client are ticked or point at the issue that keeps them

Design: docs/planning/admin-technical-spec.md, sections 2.8, 6 and 10.8 (A-47). Rows 10.2, 11.11. Takes two items of #3178. Needs every other issue of A7. The version, the tag and the approval of the release are the maintainer's. Size: M.

主要言語
C#
スター
567
フォーク
107
平均マージ
1時間 19分
マージ済み PR(30日)
353

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

fluentcms/FluentCMS のほかの issue

fluentcms/FluentCMS の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。