Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 22, 2024

add deploy script

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4920

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add deploy, remove, and update scripts for Linux.

Enhancements:

  • Update the Nginx configuration.

Deployment:

  • Add a deployment script for Linux.

@bb-auto bb-auto bot added the chore This are tasks or bot action label Dec 22, 2024
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 22, 2024

Reviewer's Guide by Sourcery

This PR adds a deploy script for Linux and updates the Nginx configuration. The deploy script clones the BootstrapBlazor repository, installs necessary dependencies like Git and Nginx, copies configuration files, and sets up a systemd service. The Nginx configuration is modified to point to the correct certificate paths.

Sequence diagram for Linux deployment process

sequenceDiagram
    participant S as System
    participant D as deploy.sh
    participant G as Git
    participant N as Nginx
    D->>S: Clean environment
    D->>S: Update apt
    D->>S: Install git
    D->>G: Clone BootstrapBlazor
    D->>S: Create directories
    D->>S: Copy deployment scripts
    D->>S: Install systemd service
    D->>S: Install nginx
    D->>N: Copy nginx config
    D->>N: Copy SSL certificates
Loading

File-Level Changes

Change Details Files
Add deploy script
  • A new deploy script was added to automate the deployment process on Linux systems.
  • The script installs Git, Nginx, clones the BootstrapBlazor repository, copies configuration files, and sets up a systemd service.
  • The script also includes steps to clean the environment and update the system.
scripts/linux/deploy.sh
Add remove script
  • A new removal script was added to remove the application and related files from the system.
scripts/linux/remove.sh
Update Nginx configuration
  • The Nginx configuration was updated to correct the paths to the SSL certificates.
  • The updated paths no longer include the './' prefix, ensuring Nginx can locate the certificates correctly.
scripts/linux/nginx.conf
Add SSL certificates
  • SSL certificates for blazor.zone and www.blazor.zone were added to enable HTTPS.
scripts/linux/cert/blazor.zone.cer
scripts/linux/cert/blazor.zone.key
scripts/linux/cert/www.blazor.zone.cer
scripts/linux/cert/www.blazor.zone.key
Add systemd service file
  • A systemd service file was added to manage the BootstrapBlazor application as a service.
  • This allows the application to start automatically on system boot and be managed using systemctl commands.
scripts/linux/ba.blazor.service

Assessment against linked issues

Issue Objective Addressed Explanation
#4920 Add a deployment script for the application

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 22, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Hardcoded certificate. (link)
  • Hardcoded certificate. (link)
  • Hardcoded private key. (link)
  • Hardcoded private key. (link)

Overall Comments:

  • The deploy.sh script uses sudo commands throughout. Consider removing sudo from the script and instead documenting that it should be run with appropriate privileges. This is safer and more flexible for different deployment environments.
  • Add error checking and exit on failure in deploy.sh. The script should verify each critical operation (git clone, directory creation, file copies) succeeds before continuing.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🔴 Security: 4 blocking issues
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang merged commit ece2207 into main Dec 22, 2024
3 checks passed
@ArgoZhang ArgoZhang deleted the dev-deploy branch December 22, 2024 12:33
@codecov
Copy link

codecov bot commented Dec 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d967b41) to head (d5a1f89).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4921   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          628       628           
  Lines        28073     28073           
  Branches      4038      4038           
=========================================
  Hits         28073     28073           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore This are tasks or bot action

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(Deploy): add deploy script

2 participants