Skip to content

include FrendsTaskMetadata#54

Open
MichalFrends1 wants to merge 1 commit intomainfrom
FSPW-722
Open

include FrendsTaskMetadata#54
MichalFrends1 wants to merge 1 commit intomainfrom
FSPW-722

Conversation

@MichalFrends1
Copy link
Contributor

@MichalFrends1 MichalFrends1 commented Feb 23, 2026

Please review my changes :)

Review Checklist

  • Task version updated (x.x.0)
  • CHANGELOG.md updated
  • Solution builds
  • Warnings resolved (if possible)
  • Typos resolved
  • Tests cover new code
  • Description how to run tests locally added to README.md (if needed)
  • All tests pass locally

Summary by CodeRabbit

  • Bug Fixes
    • Fixed an issue where FrendsTaskMetadata.json was not properly included in the NuGet package distribution, ensuring all necessary files are available during deployment.

@coderabbitai
Copy link

coderabbitai bot commented Feb 23, 2026

Walkthrough

Version 2.1.0 patch release for Amazon S3 CreateBucket task. Updates changelog documentation and reconfigures the .csproj file to ensure FrendsTaskMetadata.json is properly included in the NuGet package distribution.

Changes

Cohort / File(s) Summary
Version & Packaging Updates
Frends.AmazonS3.CreateBucket/CHANGELOG.md, Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket.csproj
Bumped version from 2.0.0 to 2.1.0. Reconfigured FrendsTaskMetadata.json packaging by removing old AdditionalFiles configuration and introducing a Content item with Pack="true" and PackagePath="/" to ensure inclusion in NuGet package. Added changelog entry documenting the fix.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • MatteoDelOmbra

Poem

🐰 A tiny metadata file, once lost,
Now nestled safe within the package crossed,
Version up to 2.1 we hop,
No more missing pieces—the fix won't stop! 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly addresses the main change: ensuring FrendsTaskMetadata.json is included in the NuGet package through project file configuration updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch FSPW-722

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 and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (2)
Frends.AmazonS3.CreateBucket/CHANGELOG.md (1)

3-5: LGTM — new entry is correctly formatted and descriptive.

The [2.1.0] entry follows Keep a Changelog conventions: correct heading level, valid change-type (Fixed), and the description accurately captures the functional packaging change without noisy refactoring notes.

One optional improvement for the file overall (pre-existing gap, not introduced here): Keep a Changelog recommends an [Unreleased] section at the top and version-comparison links at the bottom (e.g., [2.1.0]: https://github.com/.../compare/v2.0.0...v2.1.0). These make it easier to track in-progress work and diff releases.

As per coding guidelines, changelog entries should be validated against Keep a Changelog (https://keepachangelog.com/en/1.0.0/), which recommends both an [Unreleased] section and version-diff links at the bottom of the file.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@Frends.AmazonS3.CreateBucket/CHANGELOG.md` around lines 3 - 5, Add an
[Unreleased] section at the top of CHANGELOG.md and append version comparison
links at the bottom so the file complies with Keep a Changelog; specifically,
keep the existing [2.1.0] Fixed entry as-is and add an initial "[Unreleased]"
heading with a short placeholder or pending changes list, then add a link
reference like "[2.1.0]: <repository-compare-URL-for-v2.0.0...v2.1.0>" (and
optionally an "[Unreleased]: <repository-compare-URL-for-unreleased...v2.1.0>")
so readers can compare releases.
Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket.csproj (1)

18-24: FrendsTaskMetadata.json packaging is correctly configured.

  • AdditionalFiles feeds the FrendsTaskAnalyzers Roslyn analyzer.
  • Content with Pack="true" and PackagePath="/" mirrors the existing convention for migration.json and CHANGELOG.md.
  • CopyToOutputDirectory="PreserveNewest" ensures the metadata is available in the output directory for local testing.

Optionally, the Content entry could be moved into the existing ItemGroup at lines 26–29 to keep all content items together, leaving the new ItemGroup to only hold the AdditionalFiles entry.

♻️ Optional consolidation
-	<ItemGroup>
-		<AdditionalFiles Include="FrendsTaskMetadata.json" />
-		<Content Include="FrendsTaskMetadata.json"
-				 Pack="true"
-				 PackagePath="/"
-				 CopyToOutputDirectory="PreserveNewest" />
-	</ItemGroup>
-
  <ItemGroup>
+   <AdditionalFiles Include="FrendsTaskMetadata.json" />
+   <Content Include="FrendsTaskMetadata.json" Pack="true" PackagePath="/" CopyToOutputDirectory="PreserveNewest" />
    <Content Include="migration.json" PackagePath="/" Pack="true" />
    <Content Include="../CHANGELOG.md" PackagePath="/" Pack="true" />
  </ItemGroup>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket.csproj`
around lines 18 - 24, The CSProj currently has two ItemGroup entries for
FrendsTaskMetadata.json; consolidate the Content element into the existing
ItemGroup that holds other Content items by moving the Content
Include="FrendsTaskMetadata.json" (with Pack="true" PackagePath="/"
CopyToOutputDirectory="PreserveNewest") into the existing ItemGroup and leave
the new ItemGroup containing only AdditionalFiles
Include="FrendsTaskMetadata.json" to feed the FrendsTaskAnalyzers; ensure the
AdditionalFiles element remains intact and the Content entry retains its
Pack/PackagePath/CopyToOutputDirectory attributes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@Frends.AmazonS3.CreateBucket/CHANGELOG.md`:
- Around line 3-5: Add an [Unreleased] section at the top of CHANGELOG.md and
append version comparison links at the bottom so the file complies with Keep a
Changelog; specifically, keep the existing [2.1.0] Fixed entry as-is and add an
initial "[Unreleased]" heading with a short placeholder or pending changes list,
then add a link reference like "[2.1.0]:
<repository-compare-URL-for-v2.0.0...v2.1.0>" (and optionally an "[Unreleased]:
<repository-compare-URL-for-unreleased...v2.1.0>") so readers can compare
releases.

In
`@Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket.csproj`:
- Around line 18-24: The CSProj currently has two ItemGroup entries for
FrendsTaskMetadata.json; consolidate the Content element into the existing
ItemGroup that holds other Content items by moving the Content
Include="FrendsTaskMetadata.json" (with Pack="true" PackagePath="/"
CopyToOutputDirectory="PreserveNewest") into the existing ItemGroup and leave
the new ItemGroup containing only AdditionalFiles
Include="FrendsTaskMetadata.json" to feed the FrendsTaskAnalyzers; ensure the
AdditionalFiles element remains intact and the Content entry retains its
Pack/PackagePath/CopyToOutputDirectory attributes.

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d41057 and 1cd3151.

📒 Files selected for processing (2)
  • Frends.AmazonS3.CreateBucket/CHANGELOG.md
  • Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket/Frends.AmazonS3.CreateBucket.csproj

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