Skip to content

Add obsolete-APIs diagnostic-ID registry (FALLOUTOBS0xx)#472

Merged
ITaluone merged 1 commit into
Fallout-build:mainfrom
avidenic:docs/obsolete-apis-registry
Jul 10, 2026
Merged

Add obsolete-APIs diagnostic-ID registry (FALLOUTOBS0xx)#472
ITaluone merged 1 commit into
Fallout-build:mainfrom
avidenic:docs/obsolete-apis-registry

Conversation

@avidenic

@avidenic avidenic commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Add docs/obsolete_apis.md — the canonical registry of FALLOUTOBS0xx diagnostic IDs for [Obsolete] deprecations.

Why

A warning-level [Obsolete] can break consumers building with TreatWarningsAsErrors. A per-deprecation DiagnosticId lets them NoWarn a single deprecation instead of blanket-disabling CS0618.

What

  • New registry doc, mirroring docs/experimental-apis.md but with a separate FALLOUTOBS0xx sequence — a NoWarn can never collide between an experimental and an obsolete API.
  • [Obsolete] + DiagnosticId convention section in docs/agents/conventions.md; cross-linked from AGENTS.md rule Enterprise hardening: repo nuget.config breaks corporate packageSourceMapping setups #2.
  • Scaffold only: registry starts empty (commented allocation example). The first ID is allocated by the work that consumes it.

Builds on

FALLOUTOBS001 (legacy workflow_dispatch input arrays) is allocated + wired onto the [Obsolete] attributes in the typed-dispatch-inputs PR (#386).

Docs-only — CI ignores **/*.md.

Introduce docs/obsolete_apis.md as the canonical registry of FALLOUTOBS0xx
diagnostic IDs for [Obsolete] deprecations, so TreatWarningsAsErrors consumers
can NoWarn a single deprecation instead of blanket-disabling CS0618. Mirrors the
[Experimental] FALLOUT0xx registry but uses a separate, never-colliding ID
sequence.

Document the [Obsolete] + DiagnosticId convention in docs/agents/conventions.md
and cross-link both from AGENTS.md rule Fallout-build#2. Scaffold only: the registry starts
empty; the first ID (FALLOUTOBS001, legacy workflow_dispatch input arrays) is
allocated by the typed-dispatch-inputs work that builds on it.
@avidenic avidenic self-assigned this Jul 8, 2026
@avidenic avidenic added the documentation Improvements or additions to documentation label Jul 8, 2026
@avidenic avidenic marked this pull request as ready for review July 8, 2026 13:41
@ChrisonSimtian ChrisonSimtian added the Can Merge These PRs are just waiting to be merged, nothing more to do and maintainer has approved label Jul 10, 2026
@ITaluone ITaluone merged commit 742261f into Fallout-build:main Jul 10, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Can Merge These PRs are just waiting to be merged, nothing more to do and maintainer has approved documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants