-
Notifications
You must be signed in to change notification settings - Fork 9
feat(release): Add configuration for Commitizen and GitHub Actions for release #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…r versioning and release management
|
Caution Review failedThe pull request is closed. Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughThis PR establishes automated release infrastructure and configuration management. It adds Commitizen for version control, a GitHub Actions workflow for automated version bumping and PyPI publishing, updates project metadata and tooling configurations in pyproject.toml, enables VSCode folder exclusion in gitignore, and switches the default backend from Jaeger to Traceloop. Changes
Sequence Diagram(s)sequenceDiagram
actor User
participant GitHub as GitHub Actions
participant Commitizen as Commitizen
participant PyPI as PyPI
User->>GitHub: Trigger release workflow
GitHub->>GitHub: bump-version job
GitHub->>Commitizen: Run commitizen-action
Commitizen->>Commitizen: Bump version & generate changelog
GitHub->>GitHub: Create GitHub Release
GitHub->>GitHub: build-and-publish job
GitHub->>PyPI: Publish wheels & sdists
GitHub->>GitHub: test-installation job
GitHub->>PyPI: Wait for indexing
GitHub->>PyPI: Install from PyPI
GitHub->>GitHub: Verify installation & version
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Poem
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
⛔ Files ignored due to path filters (1)
📒 Files selected for processing (6)
Comment |
…try-mcp-server into dk/release-pipeline
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Caution
Changes requested ❌
Reviewed everything up to 3db64d8 in 2 minutes and 32 seconds. Click for details.
- Reviewed
936lines of code in6files - Skipped
1files when reviewing. - Skipped posting
7draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. .github/workflows/release.yml:36
- Draft comment:
Ensure GitHub CLI (gh) is available on the runner; if not, add an installation step before using 'gh release create'. - Reason this comment was not posted:
Comment did not seem useful. Confidence is useful =0%<= threshold50%This comment is asking the PR author to ensure that a tool is available in the environment, which is similar to asking them to double-check or verify something. It doesn't provide a specific code suggestion or point out a specific issue with the code itself. Therefore, it seems to violate the rules.
2. .github/workflows/release.yml:62
- Draft comment:
Checkout step in 'build-and-publish' uses ref: 'main'. Confirm that the bumped version commit is on 'main' or consider checking out the commit by SHA. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% The comment says "Confirm that..." and "consider checking out..." - these are exactly the types of phrases the rules say to avoid. The rules explicitly state: "Do NOT ask the PR author to confirm their intention, to explain, to double-check things, to ensure the behavior is intended" and "Do NOT make speculative comments". This comment is asking for confirmation and making a speculative suggestion. The workflow appears to be correctly structured with theneeds: bump-versiondependency ensuring the first job completes before the second, and checking out main should get the bumped version. This is a standard pattern for release workflows. Maybe there's a legitimate race condition or timing issue where checking out main might not get the latest commit? Perhaps the commitizen action doesn't actually push to main, or there's some other workflow configuration issue I'm not seeing? Even if there could be a timing issue, the comment doesn't definitively identify a problem - it asks to "confirm" and "consider", which are speculative phrases. If there was a real issue, the comment should state it definitively and provide a clear fix. Theneeds: bump-versiondependency should ensure proper ordering. This comment should be deleted because it asks the author to "confirm" and "consider" rather than identifying a definite issue with a clear fix. This violates the rule against asking authors to confirm intentions or making speculative comments.
3. README.md:5
- Draft comment:
Typo: "OpenLLMetry semantic conventions" appears to be a misspelling. If this is meant to refer to OpenTelemetry, please update accordingly. - Reason this comment was not posted:
Comment was on unchanged code.
4. README.md:604
- Draft comment:
There's a potential typo in the project name in the related projects section: "OpenLLMetry". Please verify if this is the intended name or if it should be corrected to "OpenTelemetry". - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
5. README.md:612
- Draft comment:
There's a typo in the GitHub Issues URL: it says 'openllmetry-mcp', but it should probably be 'opentelemetry-mcp'. - Reason this comment was not posted:
Comment was on unchanged code.
6. pyproject.toml:11
- Draft comment:
Typographical Error: The value for the license text contains an extra set of quotes. It currently reads {text = ""Apache-2.0"} and should likely be corrected to {text = "Apache-2.0"}. - Reason this comment was not posted:
Marked as duplicate.
7. pyproject.toml:31
- Draft comment:
Typographical Error: The classifier for Apache-2.0 includes extraneous quotes within the string. It currently reads "License :: OSI Approved :: "Apache-2.0 License"". Consider removing the inner quotes to ensure consistency. - Reason this comment was not posted:
Marked as duplicate.
Workflow ID: wflow_rLSC3a4roLnmjx55
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
|
|
||
| - name: Bump version | ||
| id: cz | ||
| uses: commitizen-tools/commitizen-action@master |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pin the commitizen action version instead of using @master to avoid unexpected changes.
| uses: commitizen-tools/commitizen-action@master | |
| uses: commitizen-tools/commitizen-action@v3 |
Important
Adds GitHub Actions workflow for automated releases with Commitizen, updates license, and modifies dependencies.
release.ymlworkflow for manual release via GitHub Actions UI.README.mdfrom MIT to Apache 2.0.uvicornto dependencies inuv.lock.rpds-pyversion from0.28.0to0.29.0inuv.lock.This description was created by
for 3db64d8. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit
Documentation
Chores