Merge pull request #51 from Sythsaz/chore/release-v1.5.7

chore(release): v1.5.7

Author: Sythsaz

.github/workflows/release.yml

@@ -33,7 +33,6 @@ jobs:
 
           artifacts=(
             "GiveawayBot.cs"
-            "README.md"
             "CHANGELOG.md"
           )
 
@@ -47,8 +46,11 @@ jobs:
       - name: Create Release
         uses: softprops/action-gh-release@v2
         with:
-          body: ${{ steps.extract_notes.outputs.release_notes }}
+          body: |
+            ${{ steps.extract_notes.outputs.release_notes }}
+
+            ---
+            **Full Documentation**: https://github.com/Sythsaz/Giveaway-Bot/wiki
           files: |
             GiveawayBot.cs
-            README.md
             CHANGELOG.md

CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.7] - 2026-02-08
+
+### Changed
+
+- **Release Workflow**: Updated `tools/auto-release.ps1` to create temporary `chore/release-vX.Y.Z` branches and open
+  Pull Requests, replacing the previous `release/vX.Y.Z` branch strategy to better align with conventional commits.
+- **Documentation**: Updated `CONTRIBUTING.md` to reflect the new PR-based release workflow.
+- **Documentation**: Corrected the configuration directory path in `README.md` and `CONTRIBUTING.md` from
+  `Giveaway Helper` to `Giveaway Bot`.
+- **Release Assets**: Removed `README.md` from release artifacts in favor of linking to the
+  [Wiki](https://github.com/Sythsaz/Giveaway-Bot/wiki) in the release notes.
+- **Tests**: Fixed incorrect directory path in `IntegrationTests.cs` to match the actual `Giveaway Bot` folder.
+
 ## [1.5.6] - 2026-02-08
 
 ### Fixed

CONTRIBUTING.md

@@ -248,7 +248,7 @@ dotnet run
 
 1. **Copy `GiveawayBot.cs`** to Streamer.bot
 2. **Import** into a C# action
-3. **Configure** `giveaway_config.json` in `data/Giveaway Helper/config/`
+3. **Configure** `giveaway_config.json` in `data/Giveaway Bot/config/`
 4. **Run** `!giveaway system test` in chat
 5. **Test your changes** with real commands
 
@@ -302,27 +302,31 @@ The workflow `.github/workflows/version-consistency.yml` enforces this and fails
 
 We use a streamlined **PR-based release workflow**. To release a new version:
 
-1. **Run the auto-release script**:
+1. **Prepare the Changelog**:
+   - Ensure all notable changes are documented in `CHANGELOG.md` under the `[Unreleased]` section.
+   - The script will automatically move these items to the new version section.
+
+2. **Run the auto-release script**:
 
    ```powershell
    # Syntax: .\tools\auto-release.ps1 -Version <NEW_VERSION>
    .\tools\auto-release.ps1 -Version 1.6.0
    ```
 
    This script will automatically:
-   - Create a release branch (`release/v1.6.0`)
    - Bump version in `VERSION`, `.csproj`, `.cs`, and `.wiki`
    - Update `CHANGELOG.md` (preserving `[Unreleased]` section)
-   - Open a Pull Request via GitHub CLI (`gh`)
+   - Create a temporary branch and open a Pull Request via GitHub CLI (`gh`)
 
-2. **Merge the Pull Request**:
+3. **Merge the Pull Request**:
    - The script will wait for you to merge the PR.
    - Ensure all CI checks pass.
    - Merge the PR into `main`.
 
-3. **Finalize**:
+4. **Finalize**:
    - The script will detect the merge, pull `main`, and push the `v1.6.0` tag.
    - This tag triggers the final GitHub Release workflow.
+   - **Cleanup**: The script automatically deletes both the local and remote release branches.
 
 ### Wiki Generation
 

GiveawayBot.cs

@@ -448,7 +448,7 @@ public static string Get(string key, string profileName, params object[] args)
     /// </summary>
     public class GiveawayManager : IDisposable
     {
-        public const string Version = "1.5.6"; // Semantic Versioning (canonical: VERSION file)
+        public const string Version = "1.5.7"; // Semantic Versioning (canonical: VERSION file)
 
         // ==================== Instance Fields ====================
 

README.md

@@ -55,7 +55,7 @@ All documentation has moved to the **[GitHub Wiki](https://github.com/Sythsaz/Gi
    - Paste the contents of `GiveawayBot.cs`.
    - Click "Compile" (Ensure you have added the references first).
 3. **Configure**:
-   - The bot will generate a config file at `.../Streamer.bot/data/Giveaway Helper/config/giveaway_config.json`.
+   - The bot will generate a config file at `.../Streamer.bot/data/Giveaway Bot/config/giveaway_config.json`.
    - Edit this file or use the [Example Configs](examples/).
 4. **Run**:
    - Type `!giveaway system test` in chat to verify installation.
@@ -70,7 +70,6 @@ All documentation has moved to the **[GitHub Wiki](https://github.com/Sythsaz/Gi
 Each GitHub release is expected to include these assets:
 
 - `GiveawayBot.cs`
-- `README.md`
 - `CHANGELOG.md`
 
 ## 🤝 Contributing

RELEASE_NOTES.md

@@ -1,4 +1,4 @@
-# Release Notes v1.5.6
+# Release Notes v1.5.7
 
 ## Security Section Guidance
 

StreamerBot.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net481</TargetFramework>
-    <Version>1.5.6</Version>
+    <Version>1.5.7</Version>
     <!-- Enforce C# 7.3 compatibility (Streamer.bot runtime constraint) -->
     <LangVersion>7.3</LangVersion>
     <!-- Disable nullable reference types (not supported in C# 7.3) -->

VERSION

@@ -1 +1 @@
-1.5.6
+1.5.7

_tests/IntegrationTests.cs

@@ -426,7 +426,7 @@ private static async Task Test_Dumps()
                 cph.Args.Clear(); cph.Args["command"] = "!draw"; cph.Args["isBroadcaster"] = true;
                 await m.ProcessTrigger(new CPHAdapter(cph, cph.Args));
                 string baseDir = AppDomain.CurrentDomain.BaseDirectory;
-                string d = Path.Combine(baseDir, "Giveaway Helper", "dumps", "Main");
+                string d = Path.Combine(baseDir, "Giveaway Bot", "dumps", "Main");
                 if (Directory.Exists(d) && Directory.GetFiles(d).Length > 0) Console.WriteLine("PASS");
                 else Console.WriteLine($"FAIL (Dir exists: {Directory.Exists(d)})");
             }

examples/05-timed-and-custom-messages.json

@@ -9,7 +9,7 @@
       },
       "MaxEntriesPerMinute": 200,
       "SubLuckMultiplier": 2,
-      
+
       "//": "Auto-close the giveaway after 5 minutes",
       "TimerDuration": "5m",
 
@@ -20,6 +20,8 @@
         "WinnerSelected": "🏆 FAST FINGERS! @{0} is the winner!",
         "EntryAccepted": "Got it {1}! You're in for the flash draw."
       },
+      "//": "Custom Discord announcement",
+      "DiscordMessage": "⚡ FLASH GIVEAWAY WINNER: **{winner}**! Claim your prize now! ⚡",
 
       "//": "Enable desktop notifications for key events",
       "ToastNotifications": {