Skip to content

docs: record keep-rationale for justified hand-rolled code#363

Closed
ChrisonSimtian wants to merge 7 commits into
spike/shim-migration-redesignfrom
refactor/358-keep-rationale-doc
Closed

docs: record keep-rationale for justified hand-rolled code#363
ChrisonSimtian wants to merge 7 commits into
spike/shim-migration-redesignfrom
refactor/358-keep-rationale-doc

Conversation

@ChrisonSimtian

Copy link
Copy Markdown
Collaborator

What

  • New docs/dependencies-kept.md: a table of code we keep hand-rolled on purpose instead of pulling in a library — crypto, path API, CI/CD config writers, parameter schema.
  • why hand-rolled XML-doc remarks added to each area so the reason lives next to the code:
  • Cross-link added from dependencies.md.

Why

  • The dependency-consolidation audit confirmed these areas are justified keeps. Recording the rationale stops them being re-litigated in future "use a library" passes.

Tests

  • Docs + XML-doc comments only. No public surface change, no behavior change, nothing to test.

Closes #358

ChrisonSimtian and others added 7 commits May 30, 2026 15:02
…330)

Implements the trigger/hygiene slice of milestone #18 (CI cost & pipeline
structure). #325 (publish-lane realignment) already landed in the ladder PR.

- #318/#326 Cross-platform gated to release intent. windows/macos no longer run
  on main/experimental pushes (or any routine push). They run only on PR-to-
  release/* or support/*, and on v* tag pushes. ("On main we've got our edge":
  the ubuntu-latest PR gate + alpha/preview pipelines.) workflow_dispatch is not
  emitted — the generator only writes it with inputs; GitHub's run re-run covers
  on-demand cross-platform.
- #322 concurrency cancel-in-progress on ubuntu/windows/macos (generator) +
  experimental.yml + preview.yml. NOT on release.yml (never cancel a publish).
- #323/#328 Canonical CI-ignore list (docs/**, .assets/**, **/*.md) on every
  PR/push trigger. (release.yml is tag-triggered, so path-ignore is N/A there.)
- #327 Codified "feature branches run zero CI until PR'd" + the trigger model in
  docs/agents/conventions.md, with what-not-to-do guards.
- #329 Dropped dead 'submodules: recursive' from all checkouts + the generator
  (no .gitmodules; full build passes without it) and the stale vendor comment.

Generated workflows regenerated from build/Build.CI.GitHubActions.cs.

Deferred (own follow-ups): #324 split Build/Test/Pack stages; #328 caching
deep-dive; #327 automated reflective guard-test (docs guard in place now).

Also unblocked publishing separately: the github-packages environment
deployment policy now allows experimental/main/release/*/support/* + v* tags.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…328) (#331)

#324 — experimental.yml and preview.yml ran `dotnet fallout Pack` only, publishing
alpha/preview packages WITHOUT running tests. Both now run `dotnet fallout Test Pack`
(release.yml + the PR gate already did). One invocation = NUKE's discrete internal
stages (Restore → Compile → Test → Pack), failing at the breaking stage; a test
failure stops the job before the push step, so untested packages never publish.
Separate per-step `dotnet fallout` invocations are avoided on purpose — each re-runs
the dependency graph (double-compile); the single invocation is the staged build.

#328 — added `restore-keys:` prefix fallback to the hand-written workflows' caches
for faster partial restores on key miss. Evaluation: current key (global.json +
*.csproj + Directory.Packages.props) is the right dependency set; no packages.lock.json
exists to add; build-output (bin/obj) caching deliberately not done (stale-artifact
risk). Canonical ignore list (docs/.assets/md) already applied in the trigger PR.

Codified both in docs/agents/conventions.md.

Deferred: #327 automated reflective guard-test (docs guard already in place).

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Repo moved ChrisonSimtian/Fallout → Fallout-build/Fallout. Owner-scoped refs that
don't auto-redirect, fixed on main:

- GitHub Packages feed URL nuget.pkg.github.com/ChrisonSimtian → /Fallout-build
  (release.yml, preview.yml, experimental.yml, + consumer docs: shim READMEs,
  from-nuke.md, release-and-versioning.md, CHANGELOG mention)
- CODEOWNERS @ChrisonSimtian@Fallout-build/maintainers (team now has Maintain access)

Feed stays PAT-gated (GitHub Packages has no anonymous access even when public; #344).
Web links / badges / issue refs redirect automatically and are left for a later sweep.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Updated star tracking links and attribution in README.
)

User feedback: AI-written issues are too complex and hard to read, especially for non-native English speakers. Require short, plain, bulleted output for issues, PR bodies/comments, and commit messages.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- add docs/dependencies-kept.md listing the deliberate keeps
  (crypto, path API, CI config writers, parameter schema)
- add 'why hand-rolled' XML-doc remarks to each area
- cross-link from dependencies.md

Closes #358

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ChrisonSimtian ChrisonSimtian requested a review from a team as a code owner June 3, 2026 07:44
@ChrisonSimtian ChrisonSimtian added the target/2026 Targets the 2026 calendar-version line (current). See ADR-0004. label Jun 3, 2026
@ChrisonSimtian

Copy link
Copy Markdown
Collaborator Author

Discarding. The agent worktrees forked from the pre-rearchitecture tree (main), so this is implemented against old paths (Fallout.Build/Common/Utilities) and does not stack cleanly on #359. Will redo on the new onion structure after #359 merges. Issue stays open.

@ChrisonSimtian ChrisonSimtian deleted the refactor/358-keep-rationale-doc branch June 3, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

target/2026 Targets the 2026 calendar-version line (current). See ADR-0004.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant