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

chore: Update server log path #37839

Merged
merged 1 commit into from
Nov 29, 2024
Merged

chore: Update server log path #37839

merged 1 commit into from
Nov 29, 2024

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Nov 29, 2024

Description

Updated path for server-logs as file was not uploading

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced a new input parameter ted_tag for specifying the TestEventDriver image tag in the CI workflow.
  • Improvements

    • Enhanced error handling with clearer messaging for database checks.
    • Improved caching mechanisms for better performance in CI tests.
    • Expanded logging and artifact upload processes for easier review of test results.

Copy link
Contributor

coderabbitai bot commented Nov 29, 2024

Walkthrough

The pull request modifies the GitHub Actions workflow in .github/workflows/ci-test-custom-script.yml. It introduces a new input parameter ted_tag for specifying the TestEventDriver image tag, refines job conditions for specific events, enhances caching mechanisms, updates server log storage paths, and improves error handling and logging for artifact uploads on failure.

Changes

File Path Change Summary
.github/workflows/ci-test-custom-script.yml - Added new input parameter ted_tag for specifying the TestEventDriver image tag.
- Refined job conditions to trigger CI tests on workflow_dispatch and repository_dispatch.
- Enhanced caching mechanism for restoring and storing previous run results.
- Updated server log storage path to ${{ github.workspace }} for consistency.
- Adjusted logic for determining run results based on previous outcomes.
- Improved error handling with explicit checks for database URL and clearer messaging for unknown types.
- Expanded logging and result collection for artifact uploads on failure.

Possibly related PRs

Suggested labels

Task, skip-changelog, CI

Suggested reviewers

  • sharat87
  • yatinappsmith

🌟 In the land of CI, where workflows play,
New tags and checks brighten the day.
Logs are stored with care,
Errors handled with flair,
A robust path forward, come what may! 🌈


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

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Nov 29, 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: 0

🧹 Outside diff range and nitpick comments (1)
.github/workflows/ci-test-custom-script.yml (1)

456-456: Fix indentation in artifact path configuration

The indentation at line 456 should align with the rest of the configuration block.

-          path: ${{ github.workspace }}/app/server/server-logs.log
+         path: ${{ github.workspace }}/app/server/server-logs.log
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fdb7e18 and 721a0be.

📒 Files selected for processing (1)
  • .github/workflows/ci-test-custom-script.yml (1 hunks)
🔇 Additional comments (2)
.github/workflows/ci-test-custom-script.yml (2)

Line range hint 37-41: LGTM: Well-structured input parameter addition

The new ted_tag parameter follows GitHub Actions best practices with a clear description and sensible default value.


Line range hint 456-471: Verify server log file existence

Ensure that the server log file is being generated at the specified path before the upload step.

✅ Verification successful

Log file generation and collection is properly configured

The workflow correctly handles log file generation and collection:

  • The appsmith container is properly set up and running
  • Docker logs are collected in two locations for redundancy:
    • ~/dockerlogs/dockerlogs-*.txt (on failure)
    • app/server/docker-logs.log (always)
  • Server logs are collected at ${{ github.workspace }}/app/server/server-logs.log
  • All log collection steps have appropriate condition triggers (if: failure() or if: always())
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that server logs are being generated at the specified path

# Check if the log files exist and are not empty
echo "Checking server logs..."
find ${{ github.workspace }}/app/server -name "server-logs.log" -type f -size +0c || echo "Server logs not found or empty"

echo "Checking docker logs..."
find ${{ github.workspace }}/app/server -name "docker-logs.log" -type f -size +0c || echo "Docker logs not found or empty"

Length of output: 361


Script:

#!/bin/bash
# Let's check the workflow file to understand the log file generation steps
echo "Checking workflow steps for log generation..."
rg -A 5 "server-logs.log|docker-logs.log" .github/workflows/ci-test-custom-script.yml

# Let's also check if there are any other workflow files that might handle these logs
echo "Checking other workflow files..."
fd -e yml -e yaml . .github/workflows --exec rg -l "server-logs.log|docker-logs.log" {}

Length of output: 1015


Script:

#!/bin/bash
# Let's check the steps before the log upload to understand the log generation
echo "Checking steps before log upload in ci-test-custom-script.yml..."
rg -B 10 "server-logs.log" .github/workflows/ci-test-custom-script.yml

# Let's also check the docker container setup to ensure appsmith container exists
echo "Checking docker container setup..."
rg -B 5 "docker.*appsmith" .github/workflows/ci-test-custom-script.yml

Length of output: 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants