chore(menuapi): Update docs and release pipeline

Tom Grobbe · Tom Grobbe · commit 7fe46ca5132d · 2026-07-27T11:21:25.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -6,8 +6,10 @@ on:
       - '**'
   pull_request:
 
+# Least privilege by default. The release job elevates its own permissions
+# (contents: write for tags/releases, id-token: write for NuGet OIDC).
 permissions:
-  contents: write
+  contents: read
 
 # Cancel any in-progress run on the same branch
 concurrency:
@@ -130,6 +132,12 @@ jobs:
     if: github.ref == 'refs/heads/fivem-enhanced'
     runs-on: windows-latest
 
+    # contents: write for the git tag + GitHub release; id-token: write so NuGet
+    # Trusted Publishing (OIDC) can mint a short-lived key (no API-key secret).
+    permissions:
+      contents: write
+      id-token: write
+
     outputs:
       release_url: ${{ steps.create_release.outputs.release_url }}
 
@@ -201,11 +209,20 @@ jobs:
 
           echo "release_url=$RELEASE_URL" >> "$GITHUB_OUTPUT"
 
-      - name: Publish NuGet — FiveM
+      # NuGet Trusted Publishing (OIDC): exchange the GitHub Actions id-token for a
+      # short-lived NuGet API key. No long-lived NUGET_API_KEY secret is needed.
+      # Requires a matching trusted-publishing policy on nuget.org (see below).
+      - name: NuGet login (trusted publishing)
+        uses: NuGet/login@v1
+        id: nuget_login
+        with:
+          user: ${{ vars.NUGET_USER }}
+
+      - name: Publish NuGet (FiveM Enhanced)
         run: >-
           dotnet nuget push
           "release-assets/MenuAPI.FiveM.Enhanced.${{ needs.version.outputs.semver }}.nupkg"
-          --api-key ${{ secrets.NUGET_API_KEY }}
+          --api-key ${{ steps.nuget_login.outputs.NUGET_API_KEY }}
           --source https://api.nuget.org/v3/index.json
           --skip-duplicate
 
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@ Designed specifically as a replacement of **NativeUI**, MenuAPI features perform
 
 This is the **FiveM Enhanced** version, targeting `net10.0` and the modern `CitizenFX.FiveM.Client` runtime.
 
+> ⚠️ **Work in progress:** MenuAPI for FiveM Enhanced is an early alpha. The API and docs are still changing, and NuGet releases are published as pre-release (`0.0.1-alpha`).
+
 This has been coded from the ground up. Using decompiled scripts from GTA V to figure out what some undocumented natives were used for.
 
 ## Installation
diff --git a/docs/enhanced/astro.config.mjs b/docs/enhanced/astro.config.mjs
@@ -24,7 +24,11 @@ export default defineConfig({
       // Point the header logo + title link at the MenuAPI chooser (see src/routeData.ts).
       routeMiddleware: './src/routeData.ts',
       // SocialIcons adds a "Back to all docs" pill into the header nav.
-      components: { SocialIcons: './src/components/SocialIcons.astro' },
+      // Banner is overridden to always show a site-wide work-in-progress notice.
+      components: {
+        SocialIcons: './src/components/SocialIcons.astro',
+        Banner: './src/components/Banner.astro',
+      },
       head: [
         { tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.googleapis.com' } },
         { tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: true } },
diff --git a/docs/enhanced/src/components/Banner.astro b/docs/enhanced/src/components/Banner.astro
@@ -0,0 +1,11 @@
+---
+// Override of Starlight's default Banner. The default only renders a banner when
+// a page sets `banner` in its frontmatter; this one always renders a site-wide
+// "work in progress" notice, since MenuAPI for FiveM Enhanced is an early alpha.
+// Using the built-in `.sl-banner` class keeps Starlight's native banner styling.
+---
+
+<div class="sl-banner">
+  ⚠️ <strong>Work in progress.</strong> MenuAPI for FiveM Enhanced is an early <strong>alpha</strong>.
+  The library, its API, and these docs are still changing and may be incomplete or inaccurate.
+</div>
diff --git a/docs/enhanced/src/content/docs/index.md b/docs/enhanced/src/content/docs/index.md
@@ -8,6 +8,10 @@ Welcome to the **MenuAPI** documentation.
 
 Here you'll find basic information about how to use MenuAPI in your projects.
 
+:::caution[Work in progress]
+**MenuAPI for FiveM Enhanced is an early alpha and a work in progress.** The library and these docs are still being built out, so expect breaking changes, missing pieces, and pages that may not yet match the latest code. The NuGet package is published as a pre-release (`0.0.1-alpha`).
+:::
+
 :::tip
 **Please choose a category on the left to get started.**
 :::
@@ -27,55 +31,72 @@ Here you'll find basic information about how to use MenuAPI in your projects.
 Here are some examples of what you can expect to be able to achieve with this API (if you put some time into it). Most of these screenshots are taken from vMenu after it was converted to this MenuAPI. Some are taken from the example menu provided with MenuAPI.
 
 <details>
-    <summary>Makeup &amp; Hair color panels, and also opacity panels.</summary>
-    They actually are just list items but you can toggle these panels to appear below the description box if you want them enabled
-    ![](https://www.vespura.com/hi/i/2018-12-15_19-35_84470_391.png)
-    ![](https://www.vespura.com/hi/i/2018-12-15_19-38_b6ca4_392.png)
-    ![](https://www.vespura.com/hi/i/2018-12-15_19-39_6abc3_393.png)
+<summary>Makeup &amp; Hair color panels, and also opacity panels.</summary>
+
+They actually are just list items but you can toggle these panels to appear below the description box if you want them enabled
+
+![](https://www.vespura.com/hi/i/2018-12-15_19-35_84470_391.png)
+![](https://www.vespura.com/hi/i/2018-12-15_19-38_b6ca4_392.png)
+![](https://www.vespura.com/hi/i/2018-12-15_19-39_6abc3_393.png)
+
 </details>
 
 <details>
-    <summary>List items</summary>
-    ![](https://www.vespura.com/hi/i/2018-12-15_19-40_2e308_394.png)
+<summary>List items</summary>
+
+![](https://www.vespura.com/hi/i/2018-12-15_19-40_2e308_394.png)
+
 </details>
 
 <details>
-    <summary>Slider items</summary>
-    You can have your own custom colors. Both background and foreground bar colors are fully customizable.
+<summary>Slider items</summary>
+
+You can have your own custom colors. Both background and foreground bar colors are fully customizable.
 
 ![](https://www.vespura.com/hi/i/2018-12-15_19-46_420c5_397.png)
 
 Optionally you can also choose from 29 different sprites to appear on either side of the slider.
+
 </details>
 
 <details>
-    <summary>Checkbox items</summary>
-    ![](https://www.vespura.com/hi/i/2018-12-15_19-54_d2c94_398.png)
+<summary>Checkbox items</summary>
+
+![](https://www.vespura.com/hi/i/2018-12-15_19-54_d2c94_398.png)
+
 </details>
 
 <details>
-    <summary>Menus without banners</summary>
-    You can create a menu without a banner if you prefer that.
-    ![](https://www.vespura.com/hi/i/2018-12-15_19-55_aea95_399.png)
+<summary>Menus without banners</summary>
+
+You can create a menu without a banner if you prefer that.
+
+![](https://www.vespura.com/hi/i/2018-12-15_19-55_aea95_399.png)
+
 </details>
 
 
 <details>
-    <summary>Customizable instructional buttons (per menu)</summary>
-    Each menu can have it's own set of instructional buttons. By default every menu has one setup for 'select' and 'cancel/back'. But you can remove those if you don't need them.
+<summary>Customizable instructional buttons (per menu)</summary>
+
+Each menu can have it's own set of instructional buttons. By default every menu has one setup for 'select' and 'cancel/back'. But you can remove those if you don't need them.
 
 You can also disable the instructional buttons all together if you want to handle that yourself.
 
 Instructional buttons instantly update if the user switches between keyboard/mouse and controller.
 
 ![](https://www.vespura.com/hi/i/2018-12-15_19-56_bc2c4_400.png)
+
 </details>
 
 
 <details>
-    <summary>Did somebody say icons?</summary>
-    We've got plenty of those! (They don't even fit on one page, seriously there are 29 icons to choose from.)
+<summary>Did somebody say icons?</summary>
+
+We've got plenty of those! (They don't even fit on one page, seriously there are 29 icons to choose from.)
 
 You can also use icons even when you have text on the right side of an item, the text will move over for your icon automatically.
+
 ![](https://www.vespura.com/hi/i/2018-12-15_20-01_32cc2_401.png)
+
 </details>
diff --git a/docs/enhanced/src/content/docs/setup.md b/docs/enhanced/src/content/docs/setup.md
@@ -6,6 +6,10 @@ title: "Setup"
 
 _Note, this is only for resource developers, don't install this on your server manually if you're not making a resource with it._
 
+:::caution[Pre-release]
+MenuAPI for FiveM Enhanced is a work in progress. Releases are published as a **pre-release** (`MenuAPI.FiveM.Enhanced`, currently `0.0.1-alpha`), so enable "include prerelease" in your NuGet client, and expect breaking changes while it stabilises.
+:::
+
 You have 2 options:
 
 1. Download the latest release zip and include the DLL as a reference in your C# project, then add `using MenuAPI;` to each file where you need to use MenuAPI.
