Skip to content

fix(build): name Etienne Lescot as the Windows publisher - #246

Open
EtienneLescot wants to merge 3 commits into
mainfrom
fix/windows-publisher-name
Open

fix(build): name Etienne Lescot as the Windows publisher#246
EtienneLescot wants to merge 3 commits into
mainfrom
fix/windows-publisher-name

Conversation

@EtienneLescot

@EtienneLescot EtienneLescot commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Windows listed the installed app's publisher as the original creator (see the Apps list entry for 1.8.0-rc.7 and earlier).

electron-builder derives that string from package.json author.name and nowhere else:

  • appInfo.companyName returns metadata.author.name (app-builder-lib/out/appInfo.js:90)
  • NsisTarget.js:488 sets COMPANY_NAME from it — that is the Publisher value Windows shows
  • AppxTarget.js:184 uses publisherDisplayName || companyName, which is why the Store package was already correct

There is no win.publisherName override in electron-builder 26 — that key was removed from the win schema and now fails config validation outright.

So author.name becomes Etienne Lescot. Siddharth Vaddem moves to contributors; README and LICENSE continue to credit him as the original creator, and the LICENSE copyright line is untouched.

Already shipped on release/v1.8.0 (tag v1.8.0 was re-cut at 40444d5a and rebuilt). This ports it to main so 1.8.1 doesn't regress.

Summary by CodeRabbit

  • Bug Fixes

    • Improved CLI transcription status messages to avoid repeating the same update for every transcribed chunk.
    • Status updates now reflect changes in the transcription phase more accurately.
  • Documentation

    • Documentation now refreshes automatically after stable releases.
  • Chores

    • Updated package credits to recognize Etienne Lescot as the author.
    • Moved Siddharth Vaddem to the contributors list.
    • Preserved the existing maintainers list.

Windows listed the installed app's publisher as the original creator.
electron-builder derives it from package.json `author.name` only
(appInfo.companyName -> NSIS COMPANY_NAME), so that is the field that
had to change; there is no win.publisherName override in electron-builder
26. Siddharth Vaddem moves to `contributors`; README and LICENSE keep
crediting him as the original creator.

The appx target was already correct via its own publisherDisplayName.
The 1.8.0 sync turned `onStatus` from a bare phase into an
`SttRendererStatus` object carrying chunk progress, but the CLI captions
runner still declared the old `(phase) => void` callback. Neither branch
was broken alone; the rebase in #245 put them together and main has not
typechecked since.

`onStatus` now also fires once per transcribed chunk rather than once per
phase, so log only on a phase change -- otherwise a long transcription
emits one identical line per chunk.
… tag

docs.yml had an `on: release` trigger so the /download page could pick up
the new assets. It could never work: a release event runs with
github.ref = refs/tags/vX.Y.Z, and the github-pages environment allows
only `main` to deploy, so the deploy job failed on every stable release.
Pre-releases skipped the build entirely, which is why v1.8.0 was the
first release to surface it.

Replace the trigger with a workflow_dispatch fired by build.yml once the
release is published. Dispatching against main satisfies the environment
policy and publishes main's docs rather than the release branch snapshot.
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The pull request updates package authorship metadata, release-triggered documentation workflows, and CLI transcription status logging.

Changes

Package metadata

Layer / File(s) Summary
Author and contributor metadata
package.json
The author changes to Etienne Lescot. Siddharth Vaddem moves to the contributors list.

Release documentation workflow

Layer / File(s) Summary
Release-triggered documentation rebuild
.github/workflows/build.yml, .github/workflows/docs.yml
Stable releases dispatch docs.yml on main. Documentation deployment runs for pushes to main or manual dispatches targeting main.

CLI transcription status

Layer / File(s) Summary
Transcription phase logging
src/cli/CliCaptionsRunner.tsx
The CLI consumes SttRendererStatus objects and logs each transcription phase only when it changes.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the publisher change but omits the required template sections for summary, type, release impact, platform impact, and testing. Use the repository template and complete the missing sections, especially type of change, release impact, desktop impact, related issue, and testing details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: setting Etienne Lescot as the Windows publisher.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/windows-publisher-name

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/build.yml:
- Around line 511-521: Update the “Refresh the docs /download page” step to
capture the run ID returned by `gh workflow run docs.yml --ref main`, then
monitor that dispatched run until completion with the GitHub CLI and fail the
release step if the docs build or deployment fails. Preserve the existing
stable-release condition and main-branch dispatch.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 40906b8d-e1f4-4f5d-a045-cfcab564b700

📥 Commits

Reviewing files that changed from the base of the PR and between 7c170c2 and 9e10946.

📒 Files selected for processing (3)
  • .github/workflows/build.yml
  • .github/workflows/docs.yml
  • src/cli/CliCaptionsRunner.tsx

Comment on lines +511 to +521
- name: Refresh the docs /download page
# Only a stable release changes what /releases/latest resolves to, so a
# pre-release would rebuild the site to byte-identical output.
#
# Dispatched against main on purpose: the github-pages environment only
# permits `main` to deploy, so docs.yml's old `on: release` trigger ran
# with a tag ref and failed its deploy every time. See docs.yml.
if: ${{ steps.release.outputs.is_prerelease == 'false' }}
env:
GH_TOKEN: ${{ secrets.OPENSCREEN_RELEASE_TOKEN }}
run: gh workflow run docs.yml --ref main --repo "$GITHUB_REPOSITORY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟠 Major | 🏗️ Heavy lift

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== workflow files =="
git ls-files '.github/workflows/*' | sed -n '1,120p'

echo
echo "== build.yml relevant section =="
sed -n '440,540p' .github/workflows/build.yml || true

echo
echo "== docs.yml ref =="
sed -n '1,220p' .github/workflows/docs.yml || true

echo
echo "== gh workflow run docs.yml references =="
rg -n "gh workflow run|publish-release|GH_TOKEN|OPENSCREEN_RELEASE_TOKEN|refs/tags|workflow_dispatch" .github/workflows || true

Repository: getopenscreen/openscreen

Length of output: 11815


🌐 Web query:

GitHub CLI gh workflow run --watch option documentation

💡 Result:

The gh workflow run command in the GitHub CLI does not currently have a --watch flag [1][2]. To monitor the progress of a workflow run triggered via the CLI, you should use the gh run watch command [3][4]. Because gh workflow run does not support an automatic watch option, common workflows involve running the command and then using gh run watch to track the result [5]. For example, after triggering a workflow, you can use gh run watch to interactively select the run or watch a specific run ID [6][3]: $ gh run watch If you want to view a run that was just triggered, you can use gh run watch without arguments to see an interactive list of recent runs, or use gh run list to find the ID of the latest run and pass it to gh run watch [6][5]. While community requests for a native --watch option on the workflow run command have been tracked [5], it has not been implemented as of August 2026.

Citations:


🌐 Web query:

site:cli.github.com manual gh workflow run --watch dispatches workflow

💡 Result:

The command 'gh workflow run --watch' is not a valid GitHub CLI command. The 'gh workflow run' command triggers a workflow and does not accept a '--watch' flag [1][2]. If you want to dispatch a workflow and then watch it, you must run two separate commands in sequence: 1. Use 'gh workflow run' to trigger the workflow [1]. 2. Use 'gh run watch' to monitor the resulting workflow run [3][4]. Example usage: gh workflow run && gh run watch The 'gh workflow run' command is used to create a 'workflow_dispatch' event for a specific workflow [1], while 'gh run watch' is used to monitor an existing run until it completes [3].

Citations:


Monitor the documentation deployment before completing the release.

gh workflow run docs.yml --ref main only dispatches the workflow and exits. If the downstream docs.yml build or GitHub Pages deployment fails, the release step completes successfully while /download can continue serving the previous release. Capture the dispatched run ID and poll it to completion, for example with gh run watch --run-id ..., or add a monitored retry/alert path.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/build.yml around lines 511 - 521, Update the “Refresh the
docs /download page” step to capture the run ID returned by `gh workflow run
docs.yml --ref main`, then monitor that dispatched run until completion with the
GitHub CLI and fail the release step if the docs build or deployment fails.
Preserve the existing stable-release condition and main-branch dispatch.

Source: MCP tools

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants