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

Add deployment script #1793

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Add deployment script #1793

merged 1 commit into from
Aug 1, 2024

Conversation

jo-elimu
Copy link
Member

@jo-elimu jo-elimu commented Jul 28, 2024

Usage: ./deploy-webapp 2.4.23

refs #1792

@jo-elimu jo-elimu self-assigned this Jul 28, 2024
@jo-elimu jo-elimu requested a review from a team as a code owner July 28, 2024 14:51
Copy link
Contributor

coderabbitai bot commented Jul 28, 2024

Walkthrough

The new script deploy-webapp.sh automates the deployment of a web application on a CentOS Stream 9 environment using Jetty. It enhances deployment efficiency by stopping the Jetty service, downloading the specified version of the application, and restarting the service, thereby minimizing downtime and improving the overall deployment process.

Changes

Files Change Summary
src/main/config/centos-stream-9/~/.elimu-ai/deploy-webapp.sh Created a new deployment script for Jetty, handling version-based download, service management, and automation of the deployment process.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant Jetty

    User->>Script: Provide version parameter
    Script->>Jetty: Stop service
    Script->>Script: Construct download URL
    Script->>Script: Download WAR file
    Script->>Jetty: Place WAR file in deployment directory
    Script->>Jetty: Restart service
    Jetty-->>Script: Service started
    Script-->>User: Deployment complete
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 92840d2 and 3a4a1d0.

Files selected for processing (1)
  • src/main/config/centos-stream-9/~/.elimu-ai/deploy-webapp.sh (1 hunks)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@jo-elimu jo-elimu requested a review from venkatesh2k3 July 28, 2024 14:51
Copy link

codecov bot commented Jul 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.19%. Comparing base (92840d2) to head (3a4a1d0).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1793   +/-   ##
=========================================
  Coverage     15.19%   15.19%           
  Complexity      450      450           
=========================================
  Files           249      249           
  Lines          7627     7627           
  Branches        798      798           
=========================================
  Hits           1159     1159           
  Misses         6418     6418           
  Partials         50       50           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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: 4

Comment on lines +6 to +8
echo "Stopping Jetty..."
systemctl stop jetty

Copy link
Contributor

Choose a reason for hiding this comment

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

Add error handling for stopping the Jetty service.

The script does not handle errors if the Jetty service fails to stop.

- echo "Stopping Jetty..."
- systemctl stop jetty
+ echo "Stopping Jetty..."
+ if ! systemctl stop jetty; then
+   echo "Error: Failed to stop Jetty service."
+   exit 1
+ fi
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.

Suggested change
echo "Stopping Jetty..."
systemctl stop jetty
echo "Stopping Jetty..."
if ! systemctl stop jetty; then
echo "Error: Failed to stop Jetty service."
exit 1
fi

Comment on lines +1 to +5
#!/bin/bash

VERSION=$1
echo "VERSION: $VERSION"

Copy link
Contributor

Choose a reason for hiding this comment

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

Add validation for the VERSION variable.

The script does not validate the VERSION variable, which could lead to issues if it is not provided or is invalid.

- VERSION=$1
- echo "VERSION: $VERSION"
+ if [ -z "$1" ]; then
+   echo "Error: VERSION argument is required."
+   exit 1
+ fi
+ VERSION=$1
+ echo "VERSION: $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.

Suggested change
#!/bin/bash
VERSION=$1
echo "VERSION: $VERSION"
#!/bin/bash
if [ -z "$1" ]; then
echo "Error: VERSION argument is required."
exit 1
fi
VERSION=$1
echo "VERSION: $VERSION"

Comment on lines +13 to +14
echo "Starting Jetty"
systemctl start jetty
Copy link
Contributor

Choose a reason for hiding this comment

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

Add error handling for starting the Jetty service.

The script does not handle errors if the Jetty service fails to start.

- echo "Starting Jetty"
- systemctl start jetty
+ echo "Starting Jetty"
+ if ! systemctl start jetty; then
+   echo "Error: Failed to start Jetty service."
+   exit 1
+ fi
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.

Suggested change
echo "Starting Jetty"
systemctl start jetty
echo "Starting Jetty"
if ! systemctl start jetty; then
echo "Error: Failed to start Jetty service."
exit 1
fi

Comment on lines +9 to +12
WAR_FILE_URL=https://jitpack.io/com/github/elimu-ai/webapp/webapp-$VERSION/webapp-webapp-$VERSION.war
echo "Downloading WAR file from $WAR_FILE_URL"
wget -O /opt/jetty-base/webapps/webapp.war $WAR_FILE_URL

Copy link
Contributor

Choose a reason for hiding this comment

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

Add error handling for the wget command.

The script does not handle errors if the wget command fails to download the WAR file.

- echo "Downloading WAR file from $WAR_FILE_URL"
- wget -O /opt/jetty-base/webapps/webapp.war $WAR_FILE_URL
+ echo "Downloading WAR file from $WAR_FILE_URL"
+ if ! wget -O /opt/jetty-base/webapps/webapp.war $WAR_FILE_URL; then
+   echo "Error: Failed to download WAR file."
+   exit 1
+ fi
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.

Suggested change
WAR_FILE_URL=https://jitpack.io/com/github/elimu-ai/webapp/webapp-$VERSION/webapp-webapp-$VERSION.war
echo "Downloading WAR file from $WAR_FILE_URL"
wget -O /opt/jetty-base/webapps/webapp.war $WAR_FILE_URL
WAR_FILE_URL=https://jitpack.io/com/github/elimu-ai/webapp/webapp-$VERSION/webapp-webapp-$VERSION.war
echo "Downloading WAR file from $WAR_FILE_URL"
if ! wget -O /opt/jetty-base/webapps/webapp.war $WAR_FILE_URL; then
echo "Error: Failed to download WAR file."
exit 1
fi

@nya-elimu nya-elimu merged commit c9174e8 into main Aug 1, 2024
10 checks passed
@nya-elimu nya-elimu deleted the 1792-add-deployment-script branch August 1, 2024 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants