Skip to content
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

ci: ensure jq exists for container app job verifier #1217

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

arealmaas
Copy link
Collaborator

@arealmaas arealmaas commented Oct 2, 2024

Description

Related Issue(s)

  • #{issue number}

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

  • New Features

    • Enhanced job verification script to check for and install the jq command-line tool if not present.
    • Added usage parameters for job verification, improving user guidance when executing the script.
  • Bug Fixes

    • Improved error handling for missing parameters, providing clear usage messages.

@arealmaas arealmaas requested review from a team as code owners October 2, 2024 15:44
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the script .github/tools/containerAppJobVerifier.sh. It now includes a check for the jq command-line tool, attempting to install it via tdnf if not found. The script requires three parameters for job verification: <job-name>, <resource-group-name>, and <image-tag>, providing usage instructions if any are missing. The main functionality remains focused on verifying job execution success in Azure Container Apps, with a loop that checks the job status at intervals until completion.

Changes

File Change Summary
.github/tools/containerAppJobVerifier.sh Added a check for jq installation, defined usage parameters, and maintained job verification functionality.

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
🪧 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>, 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.

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.

Copy link

sonarcloud bot commented Oct 2, 2024

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between f2e68e8 and b008601.

📒 Files selected for processing (1)
  • .github/tools/containerAppJobVerifier.sh (1 hunks)
🧰 Additional context used
🪛 Shellcheck
.github/tools/containerAppJobVerifier.sh

[error] 1-1: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive.

(SC2148)


[warning] 1-1: To redirect stdout+stderr, 2>&1 must be last (or use '{ cmd > file; } 2>&1' to clarify).

(SC2069)

🔇 Additional comments (1)
.github/tools/containerAppJobVerifier.sh (1)

Line range hint 7-78: Approve the overall script structure and functionality

The main body of the script is well-structured and implements the job verification logic effectively. Key points:

  1. Proper parameter checking and usage instructions are in place.
  2. The use of jq for parsing JSON output from Azure CLI is appropriate.
  3. The loop for checking job status includes a sleep to prevent excessive API calls.
  4. Error handling for various scenarios (e.g., job not found, job failed) is implemented.

The script effectively achieves its purpose of verifying the success of a job execution in Azure Container Apps.

🧰 Tools
🪛 Shellcheck

[error] 1-1: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive.

(SC2148)


[warning] 1-1: To redirect stdout+stderr, 2>&1 must be last (or use '{ cmd > file; } 2>&1' to clarify).

(SC2069)

.github/tools/containerAppJobVerifier.sh Show resolved Hide resolved
@arealmaas arealmaas merged commit c08f367 into main Oct 3, 2024
23 checks passed
@arealmaas arealmaas deleted the ci/install-jq-for-containerapp-job-verifier branch October 3, 2024 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants