Skip to content

Commit

Permalink
Updated workflow, VirusTotal integration, and release formatting
Browse files Browse the repository at this point in the history
Updated the workflow name in `main.yml` to include 'Pre-Master' branch. Enhanced VirusTotal integration by updating the file upload and scan id retrieval process. Improved the 'Create Release' action and release body formatting, including the addition of '(pre-release)' in release name, user-friendly installation instructions, a new VirusTotal scan section, and a more engaging contact and support section. No changes made to 'Upload Release Asset' action.
  • Loading branch information
BoiHanny committed May 18, 2024
1 parent 586725f commit 803ddc5
Showing 1 changed file with 33 additions and 25 deletions.
58 changes: 33 additions & 25 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: .NET Core Desktop Build and Release
name: .NET Core Desktop Build and Release

on:
push:
Expand Down Expand Up @@ -54,13 +54,13 @@ jobs:
run: |
$file_path = "./MagicChatbox-${{ env.VERSION }}.zip"
$api_key = "${{ secrets.VIRUSTOTAL_API_KEY }}"
$response = Invoke-RestMethod -Uri "https://www.virustotal.com/api/v3/files" -Method Post -Headers @{
"x-apikey" = $api_key
} -Form @{
"file" = Get-Item $file_path
}
$scan_id = $response.data.id
echo "::set-output name=SCAN_ID::$scan_id"
Expand All @@ -69,11 +69,11 @@ jobs:
run: |
$api_key = "${{ secrets.VIRUSTOTAL_API_KEY }}"
$scan_id = "${{ steps.virustotal_scan.outputs.SCAN_ID }}"
$response = Invoke-RestMethod -Uri "https://www.virustotal.com/api/v3/analyses/$scan_id" -Headers @{
"x-apikey" = $api_key
}
$report_url = "https://www.virustotal.com/gui/file/$($response.meta.file_info.sha256)/detection"
echo "::set-output name=REPORT_URL::$report_url"
Expand All @@ -94,14 +94,14 @@ jobs:
GITHUB_TOKEN: ${{ secrets.MY_PAT }}
with:
tag_name: v${{ env.VERSION }}
release_name: v${{ env.VERSION }}
release_name: v${{ env.VERSION }}${{ env.PRE_RELEASE == 'true' && ' (pre-release)' || '' }}
draft: false
prerelease: ${{ env.PRE_RELEASE }}
body: |
<div align="center">
<h1>MagicChatbox v${{ env.VERSION }}</h1>
<h1>MagicChatbox v${{ env.VERSION }}${{ env.PRE_RELEASE == 'true' && ' (pre-release)' || '' }} ✨</h1>
<img src="https://img.shields.io/github/downloads/BoiHanny/vrcosc-magicchatbox/v${{ env.VERSION }}/total?color=%23AB3BFF&label=Version%20downloads&logo=%20&style=plastic" alt="Version downloads">
<p>
<a href="https://github.com/BoiHanny/vrcosc-magicchatbox/releases/download/v${{ env.VERSION }}/MagicChatbox-${{ env.VERSION }}.zip">
<img src="https://custom-icon-badges.herokuapp.com/badge/-Download-%23512BD4?style=for-the-badge&logo=download&logoColor=white" alt="Download">
Expand All @@ -112,39 +112,47 @@ jobs:
</p>
</div>
<hr>
---
<div align="center">
<h2>Download and Installation</h2>
<p>Follow these steps to download and install the latest version of MagicChatbox.</p>
<h2>🚀 Download and Installation Guide 🚀</h2>
<p>Follow these simple steps to get started with MagicChatbox:</p>
</div>
<ol>
<li>Download the .zip file from the link above.</li>
<li>Ensure you have <a href="https://dotnet.microsoft.com/en-us/download">.NET 6</a> installed.</li>
<li>Right-click on the downloaded .zip file and select <b>Extract All</b>.</li>
<li>The extracted content will be in a new folder in your downloads directory (or your chosen location).</li>
<li>Open the newly created folder.</li>
<li>Run <code>MagicChatbox.exe</code> to start the application.</li>
</ol>
1. **Download** the .zip file from the link above.
2. Make sure you have [**.NET 6**](https://dotnet.microsoft.com/en-us/download) installed on your system.
3. **Right-click** the downloaded .zip file and select <strong>Extract All</strong>.
4. Open the extracted folder from your chosen location.
5. Run <code>MagicChatbox.exe</code> to launch the application.
<hr>
---
<div align="center">
<h2>Release Notes</h2>
<p>Details about the changes and improvements in this version.</p>
<h2>🛡️ About VirusTotal Scan 🛡️</h2>
<p>We take your security seriously! Each release of MagicChatbox is scanned with VirusTotal to ensure it's free from harmful software.</p>
<p>However, please be aware that some antivirus engines might flag the application. This is due to the nature of certain components we use, such as:</p>
<ul>
<li>🔍 **Window Activity** - To show which windows you are currently focused on</li>
<li>🔗 **MediaLink Components** - For better multimedia integration</li>
<li>📊 **Component Stats** - For performance tracking</li>
<li>🌙 **AFK Module** - To detect when you are away from the keyboard</li>
<li>🎮 **OSC Controller** - To communicate with VRChat</li>
</ul>
<p>These features might trigger warnings from lesser-known scanners. Rest assured, we strive to keep our software as secure as possible and any flagged activity is closely monitored to maintain your safety.</p>
<p>For more details on the scan results, check the VirusTotal report linked above.</p>
</div>
<hr>
---
<div align="center">
<h2>Contact and Support</h2>
<p>Have any questions, suggestions, or feedback regarding MagicChatbox? We'd love to hear from you! Feel free to reach out to us through one of the following channels:</p>
<h2>📞 Need Help? We're Here for You! 📞</h2>
<p>Have any questions, suggestions, or feedback? Reach out to us through one of the following channels:</p>
<ul>
<li><strong>Discord:</strong> <a href="https://discord.gg/ZaSFwBfhvG">![Join us on Discord](https://dcbadge.vercel.app/api/server/ZaSFwBfhvG)</a></li>
<li><strong>GitHub Issues:</strong> <a href="https://github.com/BoiHanny/vrcosc-magicchatbox/issues">Report a bug or submit a feature request</a></li>
<li><strong>Wiki:</strong> <a href="https://github.com/BoiHanny/vrcosc-magicchatbox/wiki">Help & more</a></li>
</ul>
<p>We're committed to providing the best possible experience for our users. Your feedback helps us make MagicChatbox even better. Thank you for your support!</p>
</div>
- name: Upload Release Asset
Expand Down

0 comments on commit 803ddc5

Please sign in to comment.