Prepare documentation

[piotrzajac]

trafficstars

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation covering available attributes, usage examples, and customization options for test data generation and mocking in xUnit tests.
  • Introduced overview and tips for using the library, including support for various mocking libraries and handling of virtual members.
  • Provided detailed attribute references, including new and generic customization attributes, data filtering options, and integration guides.
  • Added configuration files and workflows for building and deploying documentation automatically.
  • Updated README with corrected framework URL.

[coderabbitai[bot]]

Walkthrough

A comprehensive set of new documentation files was added, covering the attributes and features of the AutoFixture.XUnit2.AutoMock library. The documentation introduces and explains test data generation, customization, and filtering attributes, provides usage examples, and offers guidance on supported mocking libraries and advanced testing tips. Additionally, new GitHub Actions workflows were added for building and deploying documentation, and CI/CD pipeline triggers were refined.

Changes

File(s)	Summary
docs/index.md	Introduces AutoFixture.XUnit2.AutoMock, its purpose, and table of contents for documentation.
docs/supported-mocking-libraries.md	Lists supported mocking libraries and their NuGet packages.
docs/attributes/index.md	Overview and categorization of all available attributes with links and brief descriptions.
docs/attributes/auto-mock-data-attribute.md docs/attributes/inline-auto-mock-data-attribute.md docs/attributes/member-auto-mock-data-attribute.md	Documents test method attributes for combining AutoFixture with mocking and static/inline data sources.
docs/attributes/customize-with-attribute.md docs/attributes/customize-with-t-attribute.md	Documents parameter customization attributes, including generic and non-generic forms, with examples.
docs/attributes/except-attribute.md docs/attributes/pick-from-range-attribute.md docs/attributes/pick-from-values-attribute.md docs/attributes/pick-negative-attribute.md	Documents data filtering attributes for value exclusion, range selection, value picking, and negativity.
docs/attributes/ignore-virtual-members-attribute.md	Documents attribute to control population of virtual members for specific parameters.
docs/tips-and-tricks.md	Provides advanced tips for fixture injection and handling virtual members with interfaces.
.github/workflows/cicd.yml	Refines CI/CD workflow triggers to exclude documentation and docs workflow files from triggering runs.
.github/workflows/docs.yml	Adds new GitHub Actions workflow to build and deploy documentation on pushes, PRs, and manual triggers.
mkdocs.yml	Adds MkDocs configuration for documentation site structure, theme, and navigation.
README.md	Corrects the URL for the xUnit2 framework in the README file.

Poem

In the warren of docs, new scrolls unfurl,
Attributes and tips in a knowledge swirl.
Mocking and filtering, customizing too,
With AutoFixture magic, tests hop right through!
🐇✨
So nibble these docs, let your tests take flight—
For every bunny loves code that’s just right!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • @coderabbitai modularize this function.
• 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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.

[codecov-commenter]

:warning: Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 100.00%. Comparing base (c4581ba) to head (de22e77). :exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #262   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           39        39           
  Lines          424       424           
  Branches        55        55           
=========================================
  Hits           424       424           

Flag	Coverage Δ
unittests	99.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.