Самообновляемое приложение Wails

Создайте каркас нового проекта на основе шаблона vanilla:

wails3 init -n updater-tutorial -t vanilla
cd updater-tutorial

Теперь у вас должен быть каталог с main.go, frontend/ и Taskfile.yml. Убедитесь, что проект собирается и запускается:

wails3 task dev

Должно открыться пустое окно Wails. Закройте приложение и продолжите.

Откройте main.go и добавьте в импорты два пакета механизма обновления:

package main

import (
    _ "embed"

    "github.com/wailsapp/wails/v3/pkg/application"
    "github.com/wailsapp/wails/v3/pkg/updater"
    "github.com/wailsapp/wails/v3/pkg/updater/providers/github"
)

Они подключают сам Updater и провайдер GitHub Releases.

app.Updater уже подключён к каждому *application.App — вам нужно лишь вызвать Init:

const currentVersion = "1.0.0"

gh, err := github.New(github.Config{
    Repository:    "yourorg/your-repo",   // ← change this
    ChecksumAsset: "SHA256SUMS",          // sibling file with sha256 digests
})
if err != nil {
    log.Fatalf("github.New: %v", err)
}

if err := app.Updater.Init(updater.Config{
    CurrentVersion: currentVersion,
    Providers:      []updater.Provider{gh},
}); err != nil {
    log.Fatalf("Updater.Init: %v", err)
}

Разместите этот код после application.New и перед app.Run().

В том же main.go добавьте пункт меню «Проверить обновления…»:

menu := app.Menu.New()
app.Menu.SetApplicationMenu(menu)
appMenu := menu.AddSubmenu("App")
appMenu.Add("Check for Updates…").OnClick(func(*application.Context) {
    go func() {
        if err := app.Updater.CheckAndInstall(context.Background()); err != nil {
            app.Logger.Error("update", "error", err)
        }
    }()
})

CheckAndInstall открывает окно обновления фреймворка, запускает Check и, если выпуск найден, автоматически запускает DownloadAndInstall. Если новых выпусков нет, окно остаётся открытым в состоянии «Обновлений нет» — пользователь закрывает его кнопкой Закрыть.

wails3 task dev

Выберите Приложение → Проверить обновления…. Окно обновления должно ненадолго открыться, обратиться к API GitHub, не найти выпусков новее 1.0.0 и перейти в состояние Обновлений нет с зелёной галочкой ✓.

Если на этом этапе возникает ошибка, обычно причина одна из следующих:

Измените currentVersion в main.go на 1.0.0 (или оставьте прежним). Выполните сборку для одной платформы, чтобы получить исполняемый файл, который можно прикрепить к выпуску:

wails3 task build:darwin
# produces bin/updater-tutorial.app
# zip it for the release asset:
cd bin && zip -r updater-tutorial-darwin-arm64.zip updater-tutorial.app && cd ..

wails3 task build:linux
# produces bin/updater-tutorial
mv bin/updater-tutorial bin/updater-tutorial-linux-amd64

wails3 task build:windows
# produces bin/updater-tutorial.exe
mv bin/updater-tutorial.exe bin/updater-tutorial-windows-amd64.exe

Создайте файл SHA256SUMS рядом с исполняемым файлом:

cd bin
shasum -a 256 updater-tutorial-* > SHA256SUMS
cat SHA256SUMS

Вы должны увидеть одну или несколько строк следующего вида:

abc123…  updater-tutorial-darwin-arm64.zip

Теперь опубликуйте это в своём репозитории GitHub как v2.0.0:

gh release create v2.0.0 \
    --title "v2.0.0" \
    --notes "First update for the self-update tutorial.

- **Bold** Markdown renders in the update window
- \`Code spans\` too
- Lists work
- GFM tables work" \
    bin/SHA256SUMS bin/updater-tutorial-*

Пока currentVersion по-прежнему имеет значение 1.0.0, снова запустите приложение:

wails3 task dev

Выберите Приложение → Проверить обновления…. На этот раз вы должны увидеть примерно следующее:

• Главный значок меняется с синей стрелки ↓ («Доступно обновление») на зелёную галочку ✓ («Обновление готово»).
• В подзаголовке отображается v1.0.0 → v2.0.0 · <size>.
• На панели примечаний к выпуску ваш Markdown отображается с полужирным начертанием, фрагментами кода и таблицей.
• Во время скачивания индикатор выполнения заполняется (это произойдёт быстро — исполняемый файл небольшой).

Updater помещает новый исполняемый файл во временный каталог. Чтобы завершить обновление:

• Нажмите Перезапустить и применить.
• Приложение завершит работу, вспомогательный процесс заменит исполняемый файл, а новый исполняемый файл запустится.
• Перезапущенное приложение сообщит версию currentVersion = "1.0.0" (поскольку мы жёстко задали её в коде), но байты файла на диске будут соответствовать сборке v2.0.0.

В реальном приложении значение currentVersion задавалось бы во время сборки через -ldflags, чтобы новый исполняемый файл знал, что теперь его версия — v2.0.0, а последующая проверка не находила обновлений.

Замените константу переменной, задаваемой во время сборки:

var (
    currentVersion = "dev" // overridden by -ldflags at release time
)

Затем укажите в команде сборки:

wails3 task build:darwin -- -ldflags "-X main.currentVersion=2.0.0"

Либо добавьте -ldflags в Taskfile.yml, чтобы значение бралось из git describe --tags.

Проверка с использованием SHA256SUMS подтверждает целостность (байты совпадают с сохранёнными в GitHub), но не подлинность (что эти байты созданы вашим конвейером выпуска, а не получены через скомпрометированную учётную запись сопровождающего). Для защиты от подмены подписывайте каждый выпуск ключом Ed25519:

# One-time: generate the keypair
ssh-keygen -t ed25519 -f updater-key -N "" -C "wails-updater"
#   updater-key      — keep secret (build server, HSM, password manager)
#   updater-key.pub  — bundle in your app

Для каждого выпуска подписывайте закрытым ключом дайджест SHA-256 каждого артефакта. Небольшая вспомогательная программа на Go:

package main

import (
    "crypto/ed25519"
    "crypto/sha256"
    "encoding/base64"
    "fmt"
    "io"
    "os"
)

func main() {
    priv, _ := os.ReadFile("updater-key")
    key := ed25519.PrivateKey(priv) // raw 64-byte private key

    f, _ := os.Open(os.Args[1])
    defer f.Close()
    h := sha256.New()
    _, _ = io.Copy(h, f)
    sig := ed25519.Sign(key, h.Sum(nil))
    fmt.Println(base64.StdEncoding.EncodeToString(sig))
}

Стандартный провайдер GitHub пока не загружает отдельный файл подписи — можно написать собственный провайдер, который будет это делать, или перейти на keygen.sh: он подписывает каждый артефакт на стороне сервера и предоставляет через API как дайджест, так и подпись.

Встройте открытый ключ в приложение:

//go:embed updater-key.pub
var updaterPublicKey []byte

app.Updater.Init(updater.Config{
    CurrentVersion: currentVersion,
    PublicKey:      updaterPublicKey,
    Providers:      []updater.Provider{gh},
})

Если задано PublicKey, любой выпуск, содержащий Signature, должен пройти проверку этим ключом. Источник выпуска не может подменить его собственным ключом — именно для этого ключ закрепляется по независимому каналу во время сборки.

Стандартное окно подходит для большинства случаев. Если вам требуется больше контроля, есть три способа настройки — выберите один с учётом необходимой степени персонализации:

app.Updater.Init(updater.Config{
    // …
    Window: &updater.BuiltinWindow{
        CSS: `:root { --accent: #ff6f00; --radius: 16px; }`,
    },
})

//go:embed updater-window.html
var updaterHTML string

app.Updater.Init(updater.Config{
    // …
    Window: &updater.BuiltinWindow{HTML: updaterHTML},
})

myWin := app.Window.NewWithOptions(application.WebviewWindowOptions{
    Title:                "My App Updater",
    Width:                520, Height: 460,
    HTML:                 updaterHTML,
    AllowSimpleEventEmit: true,  // required — see security note
})
app.Updater.Init(updater.Config{
    // …
    Window: updater.BYOWindow(myWin.AsUpdaterWindow()),
})

Чтобы выполнять проверку по таймеру вместо нажатия пункта меню или в дополнение к нему:

app.Updater.Init(updater.Config{
    CurrentVersion: currentVersion,
    Providers:      []updater.Provider{gh},
    PublicKey:      updaterPublicKey,
    CheckInterval:  6 * time.Hour,
})

При каждом срабатывании таймера выполняется тот же процесс CheckAndInstall, что и при нажатии вручную. Задайте Window: updater.WindowNone, если периодическая проверка должна выполняться незаметно, пока обновление действительно не будет найдено, а затем самостоятельно подпишитесь на EventUpdateAvailable, чтобы определить, какой пользовательский интерфейс показать.