Skip to content

BUILDING.md

Latest commit

 

History

History
79 lines (59 loc) · 3.19 KB

BUILDING.md

File metadata and controls

79 lines (59 loc) · 3.19 KB
Raw

Building

The project targets net10.0 and uses BarRaider's StreamDeck-Tools v7. You need the .NET 10 SDK - the Desktop Runtime that users install is not enough to compile.

dotnet build BitwardenCLI/BitwardenStreamdeckPlugin.csproj -c Release

The build drops a ready-to-use plugin folder at BitwardenCLI/bin/Release/com.thejoeiaut.bitwarden.sdPlugin/. Copy it into your host's plugin directory (on Windows, %APPDATA%\Elgato\StreamDeck\Plugins\, with Stream Deck closed) to test it locally.

Self-contained builds

To produce a build that carries its own runtime, publish self-contained into a .sdPlugin folder and zip that folder:

dotnet publish BitwardenCLI/BitwardenStreamdeckPlugin.csproj -c Release -r win-x64 --self-contained true -o out/com.thejoeiaut.bitwarden.sdPlugin

Swap -r win-x64 for linux-x64 or osx-arm64 to build for the other platforms. Always pass -o when publishing so the RID-specific output does not overwrite the plain dotnet build output folder.

Prefer dotnet publish -r <rid> over a plain dotnet build when you want something to ship or install. Since the plugin gained Linux and macOS targets, a plain build carries every platform's SkiaSharp natives and comes to roughly 180 MB; publishing for a single runtime keeps it near 16 MB.

Installing your build locally (Windows)

powershell -ExecutionPolicy Bypass -File tools/install-local.ps1

That publishes, stops Stream Deck, replaces %APPDATA%\Elgato\StreamDeck\Plugins\com.thejoeiaut.bitwarden.sdPlugin, starts Stream Deck again and prints the plugin's log so you can see it registered.

Stream Deck holds the plugin's executable open, so it has to be stopped for the files to be replaced - there is no way around the restart. Stream Deck usually runs at a higher integrity level than an ordinary shell, so stopping it outright needs an elevated prompt; otherwise the script asks you to quit it from its tray icon and waits (-WaitMinutes, 10 by default). Pass -SkipBuild to install the last publish again, or -NoRelaunch to leave Stream Deck closed.

Releasing

Pushing a v* tag runs the release workflow: it publishes a self-contained win-x64 build, packs it into a .streamDeckPlugin with Elgato's own packer, and opens a draft release with the package attached. Nothing is public until you press Publish.

Two things have to be in place first, and the workflow stops rather than releasing if either is missing:

  1. The version, in both BitwardenCLI/manifest.json (Version, four numbers) and BitwardenCLI/BitwardenStreamdeckPlugin.csproj (<Version>, three). The tag has to agree with them - v2.0.1 wants 2.0.1.0 and 2.0.1.
  2. A ### <version> section in the README's What has changed. The release notes are taken from it.
git tag v2.0.1
git push origin v2.0.1

Then read the draft and publish it. The Elgato Marketplace listing is a separate upload, through the Maker portal.

See also