Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion .github/workflows/package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,58 @@ jobs:
path: dist/installer/*.exe
if-no-files-found: error

windows-update:
needs: windows
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v6
with:
enable-cache: true
- name: Instalar Inno Setup
run: choco install innosetup --no-progress -y
- name: Baixar instalador da versão atual
uses: actions/download-artifact@v4
with:
name: windows-installer
path: dist/installer
- name: Gerar instalador da versão seguinte
shell: pwsh
run: |
$versionA = (uv run python -c "from learning_helper import __version__; print(__version__)").Trim()
$parts = $versionA.Split(".")
$versionB = "{0}.{1}.{2}" -f $parts[0], $parts[1], ([int]$parts[2] + 1)
$init = "src/learning_helper/__init__.py"
$content = Get-Content $init -Raw
$content = [regex]::Replace($content, '__version__ = "[^"]+"', "__version__ = `"$versionB`"")
Set-Content -Path $init -Value $content -NoNewline
powershell -NoProfile -ExecutionPolicy Bypass -File packaging/windows/build.ps1
if ($LASTEXITCODE -ne 0) { throw "build da versão $versionB falhou" }
"VERSION_A=$versionA" >> $env:GITHUB_ENV
"VERSION_B=$versionB" >> $env:GITHUB_ENV
- name: Testar atualização A -> B
shell: pwsh
run: |
$installerA = (Get-ChildItem dist/installer/*.exe |
Where-Object { $_.Name -notlike "*$env:VERSION_B*" } |
Select-Object -First 1).FullName
$installerB = (Get-ChildItem "dist/installer/LearningHelper-$env:VERSION_B-Setup.exe").FullName
powershell -NoProfile -ExecutionPolicy Bypass -File packaging/windows/test-update.ps1 `
-InstallerA $installerA `
-VersionA $env:VERSION_A `
-InstallerB $installerB `
-VersionB $env:VERSION_B `
-Force
- name: Guardar diagnóstico da atualização
if: failure()
uses: actions/upload-artifact@v4
with:
name: windows-update-diagnostics
path: |
${{ runner.temp }}/learning-helper-update-e2e/**
dist/installer/latest*.json
if-no-files-found: ignore

linux:
runs-on: ubuntu-22.04
steps:
Expand Down Expand Up @@ -156,7 +208,7 @@ jobs:

release:
if: startsWith(github.ref, 'refs/tags/v')
needs: [windows, linux]
needs: [windows, windows-update, linux]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ A seção **Dados** mostra o caminho do banco e abre a pasta onde ficam o banco

A atualização automática está disponível **a partir da v0.5.0**. Quem ainda está na v0.4.0 ou anterior precisa instalar a v0.5.0 uma vez; depois disso, as próximas versões instalam sozinhas.

Builds instalados consultam o `latest.json` da release mais recente **uma vez ao iniciar** (se a opção estiver ligada) e também pelo botão **Verificar atualizações agora** em Configurações. Não há verificação periódica enquanto o app está aberto. O repositório e as releases são públicos, então a atualização funciona sem token.
Builds instalados consultam o `latest.json` da release mais recente **uma vez ao iniciar** (se a opção estiver ligada) e também pelo botão **Verificar atualizações agora** em Configurações. Se a primeira consulta falhar (por exemplo, o Windows iniciou o app antes da rede ficar disponível), o app tenta de novo após 5, 15 e 30 minutos, sem exigir reiniciar. Não há verificação periódica depois de uma consulta bem-sucedida. O repositório e as releases são públicos, então a atualização funciona sem token.

Quando há uma versão nova:

Expand All @@ -206,7 +206,15 @@ A instalação padrão por usuário não pede senha. Se o Windows foi instalado

Para desligar a verificação automática, use a opção em **Configurações** ou defina `LEARNING_HELPER_NO_UPDATE=1` no ambiente. O botão manual continua disponível. Em execução a partir do código-fonte, o app apenas informa se há versão nova; ele não se auto-instala.

Se uma instalação falhar três vezes, o app espera 7 dias antes de tentar a mesma versão de novo. **Verificar atualizações agora** ignora esse bloqueio e tenta novamente. O andamento fica em `updates/apply.log` e em `app.log` (veja [Dados locais](#dados-locais)).
Se uma instalação falhar três vezes, o app espera 7 dias antes de tentar a mesma versão de novo. **Verificar atualizações agora** ignora esse bloqueio e tenta novamente. O andamento fica em `updates/apply.log` e em `app.log` (veja [Dados locais](#dados-locais)). No Windows, o `apply.log` registra o código de saída do instalador e, se o Setup falhar, o app é reaberto na versão atual em vez de ficar fechado; o log detalhado do Inno Setup fica em `updates/setup-<versão>.log`.

Também é possível forçar o download e a aplicação pelo terminal, sem abrir a interface:

```powershell
& "$env:LOCALAPPDATA\Programs\LearningHelper\learning-helper.exe" --apply-update
```

O comando só funciona em builds instalados e exige que o app principal esteja fechado, para não haver dois instaladores ao mesmo tempo. Ele baixa o pacote, confere o SHA-256 e dispara a instalação; o app reabre na versão nova.

### Repositório público, token e espelhos

Expand Down Expand Up @@ -294,6 +302,7 @@ A subpasta `updates/` guarda o que o atualizador precisa:
- `state.json`: última versão pendente, tentativas e bloqueio temporário;
- `manual.request`: aviso das Configurações para o overlay aplicar um download manual;
- `apply.log`: saída do instalador ou do script de atualização;
- `setup-<versão>.log`: log detalhado do Inno Setup no Windows;
- `<versão>/`: pacote baixado e conferido por SHA-256.

Ela pode ser apagada a qualquer momento; o app baixa de novo na próxima verificação.
Expand Down Expand Up @@ -370,6 +379,23 @@ As capturas precisam de uma sessão gráfica; o painel de estatísticas usa Fire

Os alvos de empacotamento (`make build`, `make appimage`, `make tarball`, `make packages`) usam a versão de `src/learning_helper/__init__.py` e podem ser sobrescritos com `make packages VERSION=0.8.1`.

### Teste de atualização no Windows

O workflow `package` tem um job `windows-update` que instala a versão atual, gera a versão seguinte, serve um `latest.json` local e valida a atualização completa (download, SHA-256, Setup silencioso, reinício e preservação do banco). Ele também testa a rejeição de um pacote com SHA-256 inválido.

Para repetir o teste manualmente em uma VM ou usuário de teste do Windows, instale o Inno Setup 6, rode `uv sync --group dev` e execute:

```powershell
powershell -NoProfile -ExecutionPolicy Bypass -File packaging/windows/test-update.ps1 `
-InstallerA "dist\installer\LearningHelper-0.8.1-Setup.exe" `
-VersionA "0.8.1" `
-InstallerB "dist\installer\LearningHelper-0.8.2-Setup.exe" `
-VersionB "0.8.2" `
-Force
```

O script usa uma pasta de dados temporária, exige `-Force` se já existir uma instalação em `%LOCALAPPDATA%\Programs\LearningHelper` e desinstala o app ao final. Os logs ficam na pasta temporária e em `updates/apply.log`.

No Windows, o `make` não vem instalado por padrão: use o Git Bash/MSYS2 (ou instale com `choco install make`). Os comandos com `uv` mostrados acima continuam funcionando normalmente.

### Branches e pull requests
Expand Down Expand Up @@ -409,6 +435,7 @@ O merge deve ser feito pela interface do GitHub ou por `gh pr merge`. O bloqueio
--settings abre a tela de configuração e sai
--stats abre as estatísticas no navegador
--check-updates consulta o manifesto de atualização e informa se há versão nova
--apply-update baixa e aplica a atualização disponível (somente build instalado)
--quit encerra app, configurações e servidor de estatísticas em execução
--debug intervalo curto e botão de fechar no overlay
--db CAMINHO usa outro arquivo SQLite
Expand All @@ -420,7 +447,7 @@ O merge deve ser feito pela interface do GitHub ou por `gh pr merge`. O bloqueio

No Windows o autostart é gerenciado pelo instalador; as duas opções de autostart apenas avisam isso e não alteram nada. As opções do lembrete de banheiro valem em qualquer plataforma e gravam a preferência no banco.

`--check-updates` não baixa nem instala nada: só consulta o `latest.json`. Ele sai com código 0 quando a consulta funciona (mesmo que haja versão nova) e 1 em caso de erro de rede/manifesto.
`--check-updates` não baixa nem instala nada: só consulta o `latest.json`. Ele sai com código 0 quando a consulta funciona (mesmo que haja versão nova) e 1 em caso de erro de rede/manifesto. `--apply-update` baixa e aplica a versão nova; sai com 0 quando não há nada a fazer ou quando a instalação foi iniciada, 1 em caso de erro de download/SHA-256 e 2 quando não está em um build instalado.

### Testes

Expand Down
26 changes: 25 additions & 1 deletion packaging/make_update_manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,21 @@ def build_manifest(
*,
tag: str | None = None,
base_url: str | None = None,
asset_keys: list[str] | None = None,
) -> dict:
release_tag = tag or f"v{version}"
release_url = base_url or (
f"https://github.com/{REPOSITORY}/releases/download/{release_tag}"
)
selected = (
list(ASSET_PATTERNS)
if asset_keys is None
else [key for key in asset_keys if key in ASSET_PATTERNS]
)
assets = {}
missing = []
for key, pattern in ASSET_PATTERNS.items():
for key in selected:
pattern = ASSET_PATTERNS[key]
name = pattern.format(version=version)
path = dist_dir / name
if not path.is_file():
Expand All @@ -50,6 +57,8 @@ def build_manifest(
}
if missing:
raise SystemExit("Arquivos ausentes para o manifesto: " + ", ".join(missing))
if not assets:
raise SystemExit("Nenhum asset selecionado para o manifesto.")
return {"version": version, "assets": assets}


Expand All @@ -59,15 +68,30 @@ def main() -> int:
parser.add_argument("--dist", type=Path, required=True)
parser.add_argument("--tag")
parser.add_argument("--base-url")
parser.add_argument(
"--assets",
help=(
"Chaves separadas por vírgula a incluir no manifesto "
"(padrão: todas). Ex.: windows_setup"
),
)
parser.add_argument("--output", type=Path)
args = parser.parse_args()

asset_keys = None
if args.assets:
asset_keys = [item.strip() for item in args.assets.split(",") if item.strip()]
unknown = [item for item in asset_keys if item not in ASSET_PATTERNS]
if unknown:
parser.error("assets desconhecidos: " + ", ".join(unknown))

version = args.version.lstrip("vV")
manifest = build_manifest(
version,
args.dist,
tag=args.tag,
base_url=args.base_url,
asset_keys=asset_keys,
)
output = args.output or (args.dist / "latest.json")
output.write_text(
Expand Down
Loading
Loading