Skip to content

Build and release deb and rpm packages for Linux - #783

Merged
ryanwelcher merged 4 commits into
WordPress:trunkfrom
jonathanbossenger:add/782-ship-deb-rpm-installers
Nov 17, 2026
Merged

ryanwelcher merged 4 commits into
WordPress:trunkfrom
jonathanbossenger:add/782-ship-deb-rpm-installers

Conversation

@jonathanbossenger

@jonathanbossenger jonathanbossenger commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Why

Add .deb and .rpm install files. Fixes #782

What changes

  • Buildkite's Linux job now builds a .deb and an .rpm alongside the AppImage and uploads all three. The job installs Debian's rpm package first, because electron-builder needs rpmbuild to build the .rpm.
  • The packages and the program they install are named wordpress-contributor-toolkit, not the npm name electron-setup-wordpress-core. Uninstalling is apt remove wordpress-contributor-toolkit or dnf remove wordpress-contributor-toolkit.
  • desktopName is wordpress-contributor-toolkit.desktop, the name of the menu entry file the packages install. On Linux, Electron uses this value to identify the running app to the desktop, so it has to match that file. A unit test keeps it in step with build.linux.executableName.
  • The menu entry is filed under Categories=Development.
  • Releases include the .deb and .rpm once this merges. RELEASING.md now has the release download five files instead of three, attach all five with gh release create, and check for five on the published release. The release skill (.claude/skills/release/, .agents/skills/release/) asks for five files to match. So merging does two things: Buildkite builds the packages, and the next release publishes them.
  • The download button on the docs site is unchanged and still offers Linux visitors the AppImage. The .deb and .rpm are on the Releases page.

How to test this

Platforms: Linux only. Use a real machine or VM with no system git installed: Debian or Ubuntu for the deb, Fedora for the rpm. Download the .deb and .rpm from this PR's Buildkite Linux Build, and check the build is for the current head commit.

Starting state: none of the app's packages installed.

  1. Run sudo apt install ./wordpress-contributor-toolkit-2.0.0-linux-amd64.deb, or on Fedora sudo dnf install ./wordpress-contributor-toolkit-2.0.0-linux-x86_64.rpm.
    Expected: the package installs with no missing dependencies, and WordPress Contributor Toolkit is listed under Development (or Programming) in the application menu.
  2. Open it from the menu.
    Expected: the app opens, and the dock or taskbar shows its own icon, not a generic one.
  3. Create a new site.
    Expected: the clone of wordpress-develop completes and the site appears in the list. There is no system git on the machine, so the bundled one did the clone.
  4. Start the development server.
    Expected: the site opens in the browser.
  5. Uninstall with sudo apt remove wordpress-contributor-toolkit or sudo dnf remove wordpress-contributor-toolkit.
    Expected: the menu entry is gone, and so is /opt/WordPress Contributor Toolkit/.

Related

Background: #388 and #467.

🤖 Generated with Claude Code, reviewed, edited and accepted by me.

jonathanbossenger and others added 2 commits November 17, 2026 12:15
Adds the deb and rpm targets back so WordPress#782 can run WordPress#388's bundled-Git
checks from a real package install. The Linux Buildkite job installs
rpmbuild and uploads both packages. The packages and the program they
install are named wordpress-contributor-toolkit instead of the npm
package name, and desktopName is set so the desktop entry's
StartupWMClass is stated rather than derived.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Electron uses desktopName as the Wayland app_id, the X11 WM_CLASS and
the name it gives xdg-settings when registering the wpct:// handler, so
it has to match the installed wordpress-contributor-toolkit.desktop. A
unit test keeps desktopName and build.linux.executableName in step.
RELEASING.md says to leave the deb and rpm out of a release until WordPress#782
is done.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

jonathanbossenger and others added 2 commits November 17, 2026 12:31
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A release now downloads, attaches and checks five files: the deb and
rpm join the Windows, macOS and AppImage installers. The release skill
wrappers ask for five files to match.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jonathanbossenger jonathanbossenger changed the title Build deb and rpm packages for Linux so #782 can test the bundled Git in them Build and release deb and rpm packages for Linux Nov 17, 2026
@jonathanbossenger
jonathanbossenger marked this pull request as ready for review November 17, 2026 10:37
@ryanwelcher
ryanwelcher requested a balanced review from Copilot November 17, 2026 14:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@ryanwelcher
ryanwelcher merged commit 78e9b3d into WordPress:trunk Nov 17, 2026
22 checks passed
ryanwelcher added a commit that referenced this pull request Nov 17, 2026
…e redesign (#777)

## Why

2.1.0 changes several flows the user guide describes, and some pages and
screenshots still showed the window from before the 2.0.0 redesign
(#591): the ☰ More menu, the "Open directory in" menu under the path,
the Mail panel, the "compact action bar", Share feedback at the top of
the sidebar.

## What changes

- **2.1.0 changes documented:**
  - **The sidebar's right-click menu (#686):** `managing-sites.md`.
- **The PR preview's sentence about where a ticket's edits go (#674):**
`applying-patches.md` and `ticket-branches.md`.
- **A failed build remembered across restarts (#716):**
`setup-wizard.md`.
- **The Code editor setting (#753) and the editor folders left out of
Changed files (#752):** `editors.md` and `settings.md`.
- **The Gutenberg issue examples (#761):** `gutenberg-issues.md` and
`submit-mentor.md` now use 71210, since 71234 is a pull request.
- **#713, #749, #748 (#772) and #773 (Xdebug):** trunk already documents
these. I merged with that text rather than duplicating it.
- **Pages from before the redesign checked against the current window:**
`managing-sites.md` and `editors.md` are rewritten. `setup-wizard.md`,
`mail.md`, `terminal.md`, `troubleshooting.md` and the README are
updated. `running-the-site.md`, `getting-started.md`, `trunk-updates.md`
and `database.md` also named the old controls, so they are fixed too.
`docs/index.md`, `submit-trac.md` and `submit-mentor.md` already matched
the app.
- **Screenshots:**
- **Fixture tier:** all fixture-tier shots retaken with `npm run shots`.
- **Two new shots:** `settings-dialog.png` for `settings.md` and
`xdebug-setup-menu.png` for `step-debugging.md`.
- **Fixed editor list:** the harness now reports the same two editors,
VS Code and PhpStorm, so those shots don't depend on what the machine
taking them has installed.

Not in this PR: `setup-wizard.png`. It's a live-tier shot, so a person
has to drive the app while it's taken: `npm run shots -- --tier=live
--only=setup-wizard` from the repository root, on macOS.

## How to test this

Platforms: any. This changes only docs and the screenshot harness. No
app code changes.

**Starting state:** this branch checked out, with `npm install` run at
the repository root.

1. Run `cd docs && npm ci && npx vitepress build`. **Expected:** the
build completes. VitePress fails a build that has a dead link.
2. Run `npx vitepress preview` in `docs/`, and open **Managing sites**,
**Opening the site in your editor**, **Settings** and **Step debugging
with Xdebug**. **Expected:** each page's screenshot matches what the
text describes, and Settings shows Theme with Light, Dark, System and
Custom.
3. With the current app open beside it, follow **Your first
contribution** in **Getting started**. **Expected:** every control the
steps name is on screen under that name.
4. From the repository root, run `node scripts/screenshots/capture.cjs
--only=settings-dialog` and then `--only=xdebug-setup-menu`.
**Expected:** both pass and leave `git status` clean.

**What must not have happened:**

- No page still names ☰, **More**, **Open directory in**, **DB inspect
(Adminer)**, the **Mail** panel or **Share feedback**. Check with `grep
-rn "☰\|More\*\* menu\|Open directory in\|DB inspect\|Share feedback"
docs/guide README.md`, which should print nothing.
- The retaken screenshots show no real user path. They all show
`/tmp/wpct-docs-fixture/…`.

## Risks and limitations

- `setup-wizard.png` is still from 12 August (see above).
- Em-dashes that were already in sentences I edited are left as they
were, to keep the diff small. New lines use colons, so `settings.md` and
`setup-wizard.md` each have one list bullet in a different style from
its neighbours.
- Review: 7 [fix here] · 0 [follow-up], all fixed. Details below.

## Related

Fixes #775

---

<details>
<summary>Review outcome (required — see AGENTS.md)</summary>

- **Review:** completed. Fresh agent context, run against
`.github/instructions/code-review.instructions.md`, on head `d0464b9` /
base `edbbb94` (trunk). `npm run lint` passed. `npm test`: 2309 pass, 0
fail, 9 skipped.
- **Architecture, security, performance, cross-platform:** no findings.
  - **7 [fix here], all fixed:**
1. Getting started step 3 pointed at the details' **Start** button,
which isn't there until the wizard is finished.
    2. The Database link was said to be in the header's server menu.
3. **Initialized** was said to follow the clone, when it follows the
install.
4. Changed files was described as one of the details rows, when it's a
separate section below Server and Build watch.
5. A "server URL" was said to appear under Server, when what's there is
**View site**.
    6. A stale "More menu" alt text was left in `trunk-updates.md`.
7. The Settings shot waited for the label rather than for the control to
be enabled.
- **2 style notes, both applied:** the Xdebug shot now uses the
fixture's exported `SERVER_URL` / `SMTP_PORT`, and its stand-in server
start now sends the mail server message too.
- **Since review:** `d0464b9 → 28409d0`. The only changes are those
fixes, which I checked line by line. Lint passes again, the docs build,
and both affected shots retake to identical images.
- **Since then:** `28409d0 → a4e137f`, three docs-only commits.
`c84912a` corrects when editor detection runs in `editors.md`. `747a7fe`
adds a sentence to `trunk-updates.md` for #770: the **Update
incomplete** banner now shows on every branch of a site, since they
share one build. `a4e137f` adds the Linux `.deb` and `.rpm` from #783 to
**Install the app** in `getting-started.md`. The docs build.

</details>

<details>
<summary>Implementation notes</summary>

- **Rebase:** the branch was rebased onto trunk after #773 and #772
landed. Trunk's paragraph on refused pull requests in
`gutenberg-issues.md` is kept, and my overlapping one is removed.
- **One timeout on the first full run:** the terminal shot timed out
once with `locator.screenshot: Timeout 30000ms exceeded`. It passed when
run on its own, and every other shot was then taken one at a time.

</details>

<details>
<summary>Screenshots or recording</summary>

The retaken shots are in `docs/public/screenshots/`. GitHub's file view
shows each one's before and after.

</details>

🤖 Generated with [Claude Code](https://claude.com/claude-code)
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.

Ship deb and rpm packages for Linux, with the bundled Git tested in each

3 participants