Skip to content

chore: ignore .local-feed/ and document build/pack-local.sh in CLAUDE.md - #104

Merged
yilmaztayfun merged 1 commit into
masterfrom
chore/local-feed-gitignore-docs
Sep 8, 2026
Merged

yilmaztayfun merged 1 commit into
masterfrom
chore/local-feed-gitignore-docs

Conversation

@yilmaztayfun

@yilmaztayfun yilmaztayfun commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add .local-feed/ to the committed .gitignore. The repo-local NuGet feed written by build/pack-local.sh (and consumed by vnext as ../aether/.local-feed) was ignored only via .git/info/exclude, which does not travel with a clone.
  • Document the local-feed workflow in CLAUDE.md: pack-local.sh usage, the -local version rule, the NuGet cache purge rationale, the consumer-side wiring in vnext and the revert-before-PR rule.

Changes

  • .gitignore.local-feed/ under the NuGet packages block.
  • CLAUDE.md — new "Local feed for unreleased work (consumed by vnext)" subsection under NuGet Packaging.

Test Plan

  • git check-ignore -v .local-feed/ resolves to the committed .gitignore entry.
  • No behaviour change; docs and ignore rules only.

Notes

Companion of burgan-tech/vnext#974 (docs/testing/integration-testing.md §8 describes the same procedure from the consumer side).

🤖 Generated with Claude Code

Summary by Sourcery

Support local unreleased package testing by committing the .local-feed/ ignore rule and documenting the producer and consumer workflow.

Enhancements:

  • Document the local NuGet feed workflow for unreleased packages, including versioning, cache management, consumer configuration, and cleanup requirements.

Documentation:

  • Add guidance for using build/pack-local.sh and consuming locally packed packages from vnext.

Chores:

  • Ensure the repository-local .local-feed/ directory is ignored by the committed .gitignore.

.local-feed/ (the repo-local NuGet feed written by build/pack-local.sh and consumed by vnext as
../aether/.local-feed) was ignored only through .git/info/exclude, which is per clone; a fresh
checkout following the local-feed procedure saw an untracked directory. It is now in the
committed .gitignore.

CLAUDE.md's NuGet section only described the release-v* publishing job; it now also documents the
local feed: pack-local.sh usage, the -local version rule, why the script purges the NuGet cache
before packing, the consumer-side wiring in vnext (nuget.config source + packageSourceMapping,
AetherPackageVersion) and the revert-before-PR rule, with a link to the full procedure in vnext.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@yilmaztayfun
yilmaztayfun requested review from a team September 8, 2026 12:27
@sourcery-ai

sourcery-ai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This documentation-only change makes the repo-local .local-feed/ output portable through a committed ignore rule and documents how to create, consume, refresh, and safely revert local -local NuGet packages when testing with vnext.

Flow diagram for the local NuGet feed workflow

flowchart LR
    A["build/pack-local.sh"] -->|packs -local versions| B[".local-feed/"]
    B -->|NuGet source ../aether/.local-feed| C["vnext nuget.config"]
    C -->|AetherPackageVersion| D["vnext build"]
    E["~/.nuget/packages cache"] -->|purged before repacking| A
    F[".gitignore"] -->|ignores| B
    D -->|revert local source and version before PR| G["vnext PR"]
Loading

File-Level Changes

Change Details Files
Make the repository-local NuGet feed consistently ignored across clones.
  • Add .local-feed/ under the NuGet ignore rules.
  • Ensure generated local packages are not accidentally committed.
.gitignore
Document the end-to-end workflow for packing unreleased packages and consuming them from vnext.
  • Document default and explicit pack-local.sh usage and the required -local version suffix.
  • Explain NuGet cache purging to avoid stale package contents when reusing a version.
  • Document vnext source and package mapping changes, version selection, and the requirement to revert them before creating a PR.
CLAUDE.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 2841e687-058d-46d0-a8bf-38e7957ffa6b


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@sonarqubecloud

sonarqubecloud Bot commented Sep 8, 2026

Copy link
Copy Markdown

@yilmaztayfun yilmaztayfun self-assigned this Sep 8, 2026
@yilmaztayfun
yilmaztayfun merged commit da7cac7 into master Sep 8, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant