-
Notifications
You must be signed in to change notification settings - Fork 1
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
fix: allow latest bus client version #18
Conversation
Warning Rate limit exceeded@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 16 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe changes in this pull request involve the addition of a new GitHub Actions workflow for automating label management on pull requests and the introduction of a workflow for stable releases. Several existing workflows related to publishing and version management have been deleted. Additionally, a modification has been made to the Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.
Actionable comments posted: 5
🧹 Outside diff range and nitpick comments (3)
requirements.txt (1)
2-2
: Excellent improvement to version constraints!The change from
>=0.0.6a22
to>=0.0.6,<2.0.0
is a significant improvement because it:
- Moves away from alpha/unstable versions
- Prevents breaking changes by capping at major version 2.0.0
- Follows semantic versioning best practices
Consider applying similar version constraints to other dependencies in the file (e.g., ovos-plugin-manager, ovos_utils) to ensure consistent version control across all dependencies.
.github/workflows/publish_stable.yml (1)
1-58
: Consider adding workflow safeguards and monitoringWhile the workflow structure is solid, consider these improvements:
- Add timeout-minutes to each job to prevent hung workflows
- Consider adding status notifications (e.g., Slack, Discord) for failed releases
- Add environment protection rules for PyPI deployments
Example configuration for environment protection:
publish_pypi: environment: name: production url: https://pypi.org/project/${{ github.event.repository.name }}🧰 Tools
🪛 actionlint
22-22: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
27-27: the runner of "actions/setup-python@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
34-34: workflow command "set-output" was deprecated. use
echo "{name}={value}" >> $GITHUB_OUTPUT
instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions(deprecated-commands)
50-50: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
🪛 yamllint
[error] 58-58: no new line character at the end of file
(new-line-at-end-of-file)
.github/workflows/release_workflow.yml (1)
1-108
: Consider adding semantic version validationGiven that this PR is titled "feat:semver", consider adding a step to validate that version bumps comply with semantic versioning rules based on PR labels (e.g., major, minor, patch). This could prevent accidental version mismatches.
Example validation:
- feat: minor version bump
- fix: patch version bump
- BREAKING CHANGE: major version bump
Would you like me to provide an implementation for semantic version validation?
🧰 Tools
🪛 actionlint
26-26: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
42-42: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
47-47: the runner of "actions/setup-python@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
54-54: workflow command "set-output" was deprecated. use
echo "{name}={value}" >> $GITHUB_OUTPUT
instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions(deprecated-commands)
76-76: the runner of "actions/setup-python@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
82-82: shellcheck reported issue in this script: SC2086:info:2:28: Double quote to prevent globbing and word splitting
(shellcheck)
94-94: shellcheck reported issue in this script: SC2034:warning:2:1: BRANCH_NAME appears unused. Verify use (or export if used externally)
(shellcheck)
🛑 Comments failed to post (5)
.github/workflows/publish_stable.yml (2)
45-58: 🛠️ Refactor suggestion
Update checkout action and add error handling
The sync_dev job needs some improvements:
Apply these changes:
runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: fetch-depth: 0 ref: master - name: Push master -> dev uses: ad-m/github-push-action@master with: github_token: ${{ secrets.GITHUB_TOKEN }} branch: dev + force: false +The changes:
- Update checkout action to v4
- Add
force: false
to prevent accidental force pushes- Add newline at end of file
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.sync_dev: needs: publish_stable if: success() # Ensure this job only runs if the previous job succeeds runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. ref: master - name: Push master -> dev uses: ad-m/github-push-action@master with: github_token: ${{ secrets.GITHUB_TOKEN }} branch: dev force: false
🧰 Tools
🪛 actionlint
50-50: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
🪛 yamllint
[error] 58-58: no new line character at the end of file
(new-line-at-end-of-file)
17-43:
⚠️ Potential issueUpdate deprecated GitHub Actions and commands
Several components need to be updated to their latest versions:
Apply these changes:
- - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: ref: dev fetch-depth: 0 - - name: Setup Python - uses: actions/setup-python@v1 + - name: Setup Python + uses: actions/setup-python@v4 with: python-version: 3.8 - name: version - run: echo "::set-output name=version::$(python setup.py --version)" + run: echo "version=$(python setup.py --version)" >> $GITHUB_OUTPUT id: version📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.publish_pypi: needs: publish_stable if: success() # Ensure this job only runs if the previous job succeeds runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: ref: dev fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. - name: Setup Python uses: actions/setup-python@v4 with: python-version: 3.8 - name: Install Build Tools run: | python -m pip install build wheel - name: version run: echo "version=$(python setup.py --version)" >> $GITHUB_OUTPUT id: version - name: Build Distribution Packages run: | python setup.py sdist bdist_wheel - name: Publish to Test PyPI uses: pypa/gh-action-pypi-publish@master with: password: ${{secrets.PYPI_TOKEN}}
🧰 Tools
🪛 actionlint
22-22: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
27-27: the runner of "actions/setup-python@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
34-34: workflow command "set-output" was deprecated. use
echo "{name}={value}" >> $GITHUB_OUTPUT
instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions(deprecated-commands)
.github/workflows/release_workflow.yml (3)
21-36: 🛠️ Refactor suggestion
Update checkout action and review Matrix token usage
- The checkout action is using an outdated version. Update to the latest version:
- - uses: actions/checkout@v2 + - uses: actions/checkout@v4
- Consider moving the Matrix channel ID to repository secrets for better maintainability.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.notify: if: github.event.pull_request.merged == true needs: publish_alpha runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Send message to Matrix bots channel id: matrix-chat-message uses: fadenb/[email protected] with: homeserver: 'matrix.org' token: ${{ secrets.MATRIX_TOKEN }} channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org' message: | new ${{ github.event.repository.name }} PR merged! https://github.com/${{ github.repository }}/pull/${{ github.event.number }}
🧰 Tools
🪛 actionlint
26-26: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
37-63: 🛠️ Refactor suggestion
Multiple improvements needed for PyPI publishing job
- Update outdated actions:
- - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - - uses: actions/setup-python@v1 + - uses: actions/setup-python@v4
- Replace deprecated
set-output
command:- run: echo "::set-output name=version::$(python setup.py --version)" + run: echo "version=$(python setup.py --version)" >> $GITHUB_OUTPUT
- Add error handling for the PyPI publish step:
- name: Publish to Test PyPI uses: pypa/gh-action-pypi-publish@master with: password: ${{secrets.PYPI_TOKEN}} + verify_metadata: true + verbose: true📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.publish_pypi: needs: publish_alpha if: success() # Ensure this job only runs if the previous job succeeds runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: ref: dev fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository. - name: Setup Python uses: actions/setup-python@v4 with: python-version: 3.8 - name: Install Build Tools run: | python -m pip install build wheel - name: version run: echo "version=$(python setup.py --version)" >> $GITHUB_OUTPUT id: version - name: Build Distribution Packages run: | python setup.py sdist bdist_wheel - name: Publish to Test PyPI uses: pypa/gh-action-pypi-publish@master with: password: ${{secrets.PYPI_TOKEN}} verify_metadata: true verbose: true
🧰 Tools
🪛 actionlint
42-42: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
47-47: the runner of "actions/setup-python@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
54-54: workflow command "set-output" was deprecated. use
echo "{name}={value}" >> $GITHUB_OUTPUT
instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions(deprecated-commands)
65-108: 🛠️ Refactor suggestion
Modernize the release proposal process
- Update outdated actions:
- - uses: actions/setup-python@v2 + - uses: actions/setup-python@v4
- Fix shellcheck issues and improve version extraction:
- name: Get version from setup.py id: get_version run: | - VERSION=$(python setup.py --version) + VERSION="$(python setup.py --version)" echo "VERSION=$VERSION" >> $GITHUB_ENV
- Replace curl with GitHub CLI for better maintainability:
- # Create a PR using GitHub API - curl -X POST \ - -H "Accept: application/vnd.github+json" \ - -H "Authorization: token $GITHUB_TOKEN" \ - -d "{\"title\":\"$PR_TITLE\",\"body\":\"$PR_BODY\",\"head\":\"$HEAD_BRANCH\",\"base\":\"$BASE_BRANCH\"}" \ - https://api.github.com/repos/${{ github.repository }}/pulls + gh pr create \ + --title "$PR_TITLE" \ + --body "$PR_BODY" \ + --base "$BASE_BRANCH" \ + --head "$HEAD_BRANCH"
- Remove unused
BRANCH_NAME
variable.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.propose_release: needs: publish_alpha if: success() # Ensure this job only runs if the previous job succeeds runs-on: ubuntu-latest steps: - name: Checkout dev branch uses: actions/checkout@v3 with: ref: dev - name: Setup Python uses: actions/setup-python@v4 with: python-version: '3.10' - name: Get version from setup.py id: get_version run: | VERSION="$(python setup.py --version)" echo "VERSION=$VERSION" >> $GITHUB_ENV - name: Create and push new branch run: | git checkout -b release-${{ env.VERSION }} git push origin release-${{ env.VERSION }} - name: Open Pull Request from dev to master env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | # Variables BASE_BRANCH="master" HEAD_BRANCH="release-${{ env.VERSION }}" PR_TITLE="Release ${{ env.VERSION }}" PR_BODY="Human review requested!" # Create a PR using GitHub CLI gh pr create \ --title "$PR_TITLE" \ --body "$PR_BODY" \ --base "$BASE_BRANCH" \ --head "$HEAD_BRANCH"
🧰 Tools
🪛 actionlint
76-76: the runner of "actions/setup-python@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
82-82: shellcheck reported issue in this script: SC2086:info:2:28: Double quote to prevent globbing and word splitting
(shellcheck)
94-94: shellcheck reported issue in this script: SC2034:warning:2:1: BRANCH_NAME appears unused. Verify use (or export if used externally)
(shellcheck)
Summary by CodeRabbit
New Features
Bug Fixes
ovos-bus-client
dependency to ensure compatibility.Chores