build: dynamic versioning based on git tags

[arunanshub]

Summary by CodeRabbit

• Chores

  • Enhanced security by updating the CI publishing process to use environment variables for authentication.
  • Updated .gitignore to exclude auto-generated versioning files.

• Documentation

  • Refined the project's build and development settings in the configuration file.

• Refactor

  • Improved version management in the codebase.

[coderabbitai]

Walkthrough

The project's configuration for continuous integration and version management has been refined. The CI pipeline now securely handles PyPI credentials, and versioning is dynamically sourced from a new template. Additionally, the development tools and ignore rules have been updated to streamline the workflow and maintain cleaner code repositories.

Changes

Files	Change Summary
.github/workflows/ci.yml	Updated the Publish Package step to use pdm publish with environment variables for PyPI credentials.
.gitignore	Added ignore rule for src/**/_version.py.
pyproject.toml	Introduced dynamic versioning with pdm as the backend; updated tool configurations.
src/sphinx_nested_apidoc/...	Updated version import and defined __all__ list.

🐰✨
A hop, a skip, in the code we dip,
To tweak and tune with a smile and swoon.
Secrets safe and versions leap,
With clean, neat tracks where none can peep.
Cheers to changes, big and small,
In our code garden, spring befalls! 🌼🌱
🐰✨

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 08a1ee8 and c6dc756.

Files selected for processing (4)

• .github/workflows/ci.yml (1 hunks)
• .gitignore (1 hunks)
• pyproject.toml (6 hunks)
• src/sphinx_nested_apidoc/init.py (2 hunks)

Files skipped from review due to trivial changes (1)

• .gitignore

Additional comments not posted (8)

src/sphinx_nested_apidoc/__init__.py (2)

5-5: Import of __version__ looks good and is essential for dynamic versioning.

---

33-33: Update to __all__ to include __version__ is appropriate for exposing it as part of the public API.

pyproject.toml (5)

24-24: The addition of the dynamic field for versioning aligns with the dynamic versioning strategy.

---

34-37: Configuration of pdm as the build backend is consistent with the new tooling strategy.

---

41-48: Configuration for dynamic versioning in pdm is correctly set up to write to _version.py.

---

91-102: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [68-99]

Updates to development tool configurations (commitizen, coverage, ruff) are well-aligned with the project's new structure and practices.

---

121-123: The isort configuration updates are minor but enhance the consistency of import formatting.

.github/workflows/ci.yml (1)

133-136: Using environment variables for PyPI credentials in the Publish Package step enhances security and aligns with best practices.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[coveralls]

Pull Request Test Coverage Report for Build 8788393821

Details

• 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.3%) to 35.683%

---

Totals
Change from base Build 8787467534:	0.3%
Covered Lines:	65
Relevant Lines:	185

---

💛 - Coveralls