Skip to content

Commit 4fb4239

Browse files
committed
Refactor deploy workflow to enhance packaging process and update release notes format
1 parent bbbcf36 commit 4fb4239

File tree

2 files changed

+84
-5
lines changed

2 files changed

+84
-5
lines changed

.github/workflows/deploy.yml

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,11 +235,10 @@ jobs:
235235
"@
236236
Set-Content -Path "Startup.txt" -Value $startupContent
237237
238-
# --- 8. PACKAGE & RELEASE ---
238+
# --- 8. PACKAGE & RELEASE (Standard Version) ---
239239
- name: Create Zip Packages
240240
run: |
241241
# Optimization: Use 7zip (faster than Compress-Archive)
242-
# We change directory to avoid including parent folders in zip structure
243242
244243
pushd Build
245244
7z a -tzip ..\Reality-Server-Full.zip * -r
@@ -271,10 +270,36 @@ jobs:
271270
### 🔧 Bundler Changelog
272271
${{ steps.tag_version.outputs.changelog }}
273272
274-
# --- 9. UPDATE LATEST TAG (Add tag to same commit) ---
275-
- name: Update 'latest' Tag
273+
# --- 9. PUBLISH LATEST RELEASE (Rolling Release) ---
274+
- name: Publish 'latest' Release
275+
env:
276+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
276277
run: |
278+
$notes = @"
279+
Automated Release ${{ steps.tag_version.outputs.new_tag }}
280+
281+
### 📦 Component Status
282+
| Component | Status | Last 3 Commits |
283+
| :--- | :--- | :--- |
284+
| **RealityMod** | $env:RM_STATUS | $env:RM_LOG |
285+
| **LevelLoader** | $env:LL_STATUS | $env:LL_LOG |
286+
| **BlueprintManager** | (Included) | $env:BP_LOG |
287+
| **VEManager** | (Included) | $env:VE_LOG |
288+
289+
### 🔧 Bundler Changelog
290+
${{ steps.tag_version.outputs.changelog }}
291+
"@
292+
Set-Content -Path release_notes.md -Value $notes
293+
294+
295+
gh release delete latest --yes || echo "No previous release found"
296+
277297
git config user.name "GitHub Actions"
278298
git config user.email "actions@github.com"
279299
git tag -f latest
280-
git push -f origin latest
300+
git push -f origin latest
301+
302+
gh release create latest `
303+
--title "Latest Build (${{ steps.tag_version.outputs.new_tag }})" `
304+
--notes-file release_notes.md `
305+
Reality-Server-Full.zip Reality-Mods-Only.zip

README.MD

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
[![Auto Build & Release](https://github.com/BF3RM/Release_Packaging/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/BF3RM/Release_Packaging/actions/workflows/deploy.yml)
2+
[![Auto Build & Release](https://github.com/BF3RM/Release_Packaging/actions/workflows/deploy.yml/badge.svg?branch=main&event=workflow_run)](https://github.com/BF3RM/Release_Packaging/actions/workflows/deploy.yml)
3+
4+
BF3 Reality Mod Server Bundler
5+
6+
A Fully automated build and setup process for all the RM Mods - with the goal to not execut anyhting locally anymore - only copying the files. (script could automate that...). Could be Also distributed to the PPL hosting the Server - which would make this setup easier-
7+
8+
Features
9+
10+
Automated Builds: Automatically compiles the RealityMod WebUI (ui.vuic) and injects required dependencies.
11+
12+
Level Generation: Runs the LevelLoader generation script automatically during the build.
13+
14+
Smart Packaging: Bundles RealityMod, LevelLoader, BlueprintManager, and VEManager into a single ready-to-use zip file.
15+
16+
Config Ready: Generates standard configuration files (Startup.txt, ModList.txt) automatically.
17+
18+
How to Use
19+
20+
Option 1: Download Release
21+
Go to the Releases tab and download:
22+
23+
Reality-Server-Full.zip: Complete server setup with default configs. (for Fresh Start)
24+
25+
Reality-Mods-Only.zip: Just the Mods folder (best for updates).
26+
27+
Option 2: Git Clone
28+
You can clone the latest tag to get the newest build artifacts:
29+
30+
git clone --branch latest [click](https://github.com/BF3RM/Release_Packaging.git)
31+
32+
33+
Manual Installation Reference
34+
35+
If you need to build this manually for debugging, here is the process this repo automates:
36+
37+
1. Install Mods
38+
39+
RealityMod: Clone the repo, navigate to WebUI, run pnpm install && pnpm build.
40+
41+
LevelLoader: Clone RMLevelLoaderGen, execute generate.bat, and move the output to Server\Admin\Mods\rm-levelloader.
42+
43+
Managers: Clone BlueprintManager and VEManager into the Mods folder.
44+
45+
2. Configuration
46+
Ensure these files exist in Server\Admin:
47+
48+
ModList.txt (List: RealityMod, rm-levelloader, BlueprintManager, VEManager)
49+
50+
Startup.txt (RCON, License Key, Admins)
51+
52+
MapList.txt (Map layers)
53+
54+
BanList.txt

0 commit comments

Comments
 (0)