feat: add gh action linter #68
Conversation
WalkthroughThis pull request introduces several changes across multiple configuration files. The GitHub Actions workflow in Changes
Possibly related PRs
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 (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
config.ini (1)
21-21: Fix typo in commentThere's a typo in the comment above the
bitbucket_hostline.Apply this diff to fix the typo:
-; Dummu local hostname +; Dummy local hostname.github/workflows/ci.yaml (1)
162-162: Docker push strategy refined for releasesThe updated push command correctly uses the release tag name, ensuring that only official releases are pushed to the registry. This aligns well with the release event condition.
However, consider the following suggestion:
To maintain a complete history of builds, consider pushing images for non-release builds as well. This can be achieved by using a similar conditional tag as in the build step. Here's a suggested improvement:
- name: Push Docker Image run: | docker push docker.io/psadi/bbcli:${{ github.event.release.tag_name || github.sha }}This way, you'll push tagged images for releases and SHA-tagged images for other builds, providing a comprehensive build history in your registry.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
pdm.lockis excluded by!**/*.lock
📒 Files selected for processing (5)
- .github/workflows/ci.yaml (2 hunks)
- .pre-commit-config.yaml (1 hunks)
- config.ini (1 hunks)
- requirements.txt (3 hunks)
- tests/props.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- requirements.txt
🧰 Additional context used
🔇 Additional comments (4)
.pre-commit-config.yaml (1)
58-61: LGTM! Consider checking for the latest stable version.The addition of actionlint to the pre-commit configuration is well-structured and aligns with the PR objective of adding a GitHub Action linter. This will help catch issues in GitHub Action workflows before they're committed.
To ensure we're using the latest stable version, let's check the actionlint releases:
If a newer stable version is available, consider updating to it for the latest features and bug fixes.
✅ Verification successful
Actionlint configuration is up to date.
The pre-commit configuration is using the latest stable version v1.7.3.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check the latest stable version of actionlint # Expect: The latest version number, which we can compare with v1.7.3 latest_version=$(gh release list --repo rhysd/actionlint --limit 1 | awk '{print $1}') echo "Latest actionlint version: $latest_version" echo "Current version in config: v1.7.3"Length of output: 250
.github/workflows/ci.yaml (3)
141-141: Improved Docker image tagging strategyThe updated tagging strategy now uses the release tag name when available, falling back to the commit SHA. This change enhances version clarity for release builds while maintaining uniqueness for non-release builds.
146-146: Consistent image reference for vulnerability scanningThe Trivy vulnerability scanner now uses the same image reference as the build step. This consistency is crucial for ensuring that the exact image built is the one being scanned, maintaining the integrity of the security process.
Line range hint
141-162: Summary: Enhanced Docker workflow with improved tagging strategyThe changes in this file significantly improve the Docker image handling in the CI pipeline:
- The build step now uses a more robust tagging strategy, preferring release tags when available.
- The Trivy vulnerability scanner step has been updated to use the same image reference, ensuring consistency in security checks.
- The push step has been refined to handle release builds correctly.
These changes enhance version clarity, maintain security practices, and streamline the release process. Consider the suggestion for the push step to further improve the workflow for non-release builds.
Overall, these modifications represent a positive enhancement to the CI pipeline, particularly for Docker image management and security practices.
| @@ -19,6 +19,6 @@ | |||
|
|
|||
| [auth] | |||
| ; Dummu local hostname | |||
| bitbucket_host = https://bb.picolo.co.in | |||
| bitbucket_host = https://bitbucket.org.com | |||
There was a problem hiding this comment.
💡 Codebase verification
Incorrect Bitbucket URL Still Present
The incorrect Bitbucket URL https://bitbucket.org.com is still found in config.ini. Please update it to https://bitbucket.org to ensure proper connectivity.
🔗 Analysis chain
Incorrect Bitbucket URL
The new Bitbucket URL https://bitbucket.org.com appears to be incorrect. The standard Bitbucket URL is https://bitbucket.org. Please verify and update the URL accordingly.
Apply this diff to fix the URL:
-bitbucket_host = https://bitbucket.org.com
+bitbucket_host = https://bitbucket.orgTo ensure this change doesn't affect other parts of the codebase, please run the following script:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for occurrences of the incorrect Bitbucket URL
# Test: Search for the incorrect URL. Expect: No results.
rg --type-add 'config:*.{ini,yaml,yml,json}' --type config 'https://bitbucket.org.com'
# Test: Search for the correct URL. Expect: At least one result in config.ini.
rg --type-add 'config:*.{ini,yaml,yml,json}' --type config 'https://bitbucket.org'
Length of output: 277
| @@ -24,7 +24,7 @@ | |||
|
|
|||
| @dataclass(frozen=True, order=True) | |||
| class Api: | |||
| bitbucket_host: str = "https://bb.picolo.co.in" | |||
| bitbucket_host: str = "https://bitbucket.org.com" | |||
There was a problem hiding this comment.
💡 Codebase verification
Incorrect Bitbucket host URL in configuration
The bitbucket_host is set to "https://bitbucket.org.com" in the following files, which is incorrect. It should be updated to "https://bitbucket.org":
config.ini:bitbucket_host = https://bitbucket.org.comtests/props.py:bitbucket_host: str = "https://bitbucket.org.com"
- bitbucket_host: str = "https://bitbucket.org.com"
+ bitbucket_host: str = "https://bitbucket.org"
- bitbucket_host = https://bitbucket.org.com
+ bitbucket_host = https://bitbucket.org🔗 Analysis chain
Verify the updated Bitbucket host URL
The default value for bitbucket_host has been changed to "https://bitbucket.org.com", which appears to be incorrect. The standard Bitbucket URL is "https://bitbucket.org".
Please confirm if this change is intentional and consistent with other configuration updates (e.g., in config.ini). If not intended for testing purposes, consider updating to the correct URL:
- bitbucket_host: str = "https://bitbucket.org.com"
+ bitbucket_host: str = "https://bitbucket.org"To verify the consistency of this change across the codebase, you can run the following script:
This will help ensure that all references to the Bitbucket host are consistent and correct throughout the project.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for occurrences of Bitbucket URLs in the codebase
echo "Searching for Bitbucket URLs in the codebase:"
rg --type-add 'config:*.{ini,yaml,yml}' --type python --type config 'https?://(?:www\.)?bitbucket\.(?:org|com)'
echo "Searching for 'bitbucket_host' occurrences:"
rg --type-add 'config:*.{ini,yaml,yml}' --type python --type config 'bitbucket_host'
Length of output: 464
Script:
#!/bin/bash
# Description: Check for occurrences of Bitbucket URLs in the codebase
echo "Searching for Bitbucket URLs in the codebase:"
rg 'https?://(?:www\.)?bitbucket\.(?:org|com)' --glob '*.py' --glob '*.ini' --glob '*.yaml' --glob '*.yml'
echo "Searching for 'bitbucket_host' occurrences:"
rg 'bitbucket_host' --glob '*.py' --glob '*.ini' --glob '*.yaml' --glob '*.yml'
Length of output: 4958
Summary by CodeRabbit
New Features
actionlintfor improved linting in pre-commit hooks.Bug Fixes
Chores