Add restore properties for NuGet in CI and include packages lock file

[snovak7]

Closes #13

Summary by CodeRabbit

• Chores
  • Improved NuGet package restore reliability and consistency by enabling lock file usage and locked mode during continuous integration builds.
  • Added a lock file to ensure consistent package versions for dependencies.
  • Enhanced build workflow caching by using lock files to optimize dependency restoration in CI.

[coderabbitai]

Walkthrough

A new PropertyGroup was added to Directory.Build.props to enable NuGet restore locked mode in CI environments and to always use package lock files. Additionally, a packages.lock.json file was introduced for the src/Escendit.Tools.CodeAnalysis.xUnitAnalyzers project, specifying exact package versions for consistent restores. The GitHub Actions workflow was updated to cache dependencies based on the lock file.

Changes

Cohort / File(s)	Change Summary
NuGet Restore Configuration Directory.Build.props	Added MSBuild properties to enable locked mode restores in CI and always use lock files for NuGet restores.
Package Lock File Addition src/Escendit.Tools.CodeAnalysis.xUnitAnalyzers/packages.lock.json	Added lock file specifying resolved package versions and dependencies for the project.
CI Workflow Cache Update .github/workflows/build.yml	Configured GitHub Actions .NET setup to use packages.lock.json for caching dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant CI as CI Build
    participant MSBuild as MSBuild
    participant NuGet as NuGet Restore

    CI->>MSBuild: Start build (CI=true)
    MSBuild->>NuGet: Restore packages (RestoreLockedMode=true)
    NuGet->>NuGet: Use packages.lock.json for dependency resolution
    NuGet-->>MSBuild: Restore completes with locked versions
    MSBuild-->>CI: Build continues with locked dependencies

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Build should be based on a lock file (if present) (#13)	✅

Poem

In the warren, code now locks in place,
NuGet restores with elegant grace.
CI hops along, no package surprise—
Consistency gleams in rabbit eyes!
With every build, the cache does sing,
Oh what delight these changes bring!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 648f250 and 2893b3a.

📒 Files selected for processing (1)

• .github/workflows/build.yml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .github/workflows/build.yml

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 13-enable-cache-capability-with-nuget-restore

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3614c19 and 648f250.

📒 Files selected for processing (2)

• Directory.Build.props (1 hunks)
• src/Escendit.Tools.CodeAnalysis.xUnitAnalyzers/packages.lock.json (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Package

src/Escendit.Tools.CodeAnalysis.xUnitAnalyzers/packages.lock.json

[error] 1-1: Dependencies lock file is not found in /home/runner/work/tools-codeanalysis-xunit/tools-codeanalysis-xunit. Supported file patterns: packages.lock.json

🔇 Additional comments (1)

src/Escendit.Tools.CodeAnalysis.xUnitAnalyzers/packages.lock.json (1)

1-47: Lock file looks good and aligns with the new restore settings

The lock file content is valid and will ensure deterministic restores for the analyzer project.