feat: Enhance CI/CD Workflow with TestPyPI Publishing, Linting Improvements, and minor docs update

jjjermiah commented 1 month ago

Summary by CodeRabbit

New Features
- Introduced a new linter job (Ruff) to enhance code quality.
- Added conditional publishing to TestPyPI and installation testing jobs.
- New tasks for linting and formatting using ruff in project configuration.
Bug Fixes
- Improved error handling and type safety in DICOM loading functions.
Documentation
- Added detailed docstrings for DICOM loading functions to clarify usage and file types.
Chores
- Updated project version to 1.11.0 and improved configuration file organization.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 63.96%. Comparing base (7bdf5d3) to head (bdb49ea). Report is 14 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #42 +/- ## ========================================== + Coverage 63.54% 63.96% +0.41% ========================================== Files 9 9 Lines 524 530 +6 ========================================== + Hits 333 339 +6 Misses 191 191 ```

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

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces significant updates to the CI-CD workflow, including new jobs for linting, publishing, and testing installations. The push event trigger has been commented out, and the pull_request trigger now accepts any branch. The ruff linter is integrated, and several jobs are added or modified to enhance the pipeline's structure. Additionally, the ruff.toml configuration is updated for linting rules and formatting preferences, while the pyproject.toml file sees improvements in task management. The src/readii/loaders.py file is modified for better type handling and documentation in DICOM loading functions.

Changes

File	Change Summary
.github/workflows/ci-cd.yml	- Added `Ruff` job for linting. - Updated `Semantic-Release` to depend on `Ruff`. - Added `Publish-To-Test-PyPi` job. - Added `Test-TestPypi-Installation` job.
config/ruff.toml	- Added `include` for `src/readii/loaders.py`. - Updated `pydocstyle` convention from `google` to `numpy`. - Changed `quote-style` from `single` to `double`.
pyproject.toml	- Updated project version to `1.11.0`. - Added `lint` and `format` tasks for `ruff`. - Added `publish-test` task for publishing to TestPyPI.
src/readii/loaders.py	- Updated function signatures to accept `str` or `Path`. - Improved type safety and error handling in DICOM loading functions.

Possibly related PRs

40: The changes in the CI-CD workflow configuration in both the main PR and this retrieved PR involve modifications to the .github/workflows/ci-cd.yml file, including job definitions and triggers, indicating a direct relationship in the context of CI/CD enhancements.

🐇 In the garden where bunnies play,
New jobs and tasks come out to stay.
Linting and publishing, oh what a sight,
With paths and formats all done just right.
Hopping along, we cheer and rejoice,
For our code now sings with a clearer voice! 🌼✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 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 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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

bhklab / readii