build(electron): fix dmg maker #5922
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Your org has enabled the Graphite merge queue for merging into canaryYou must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link. You can enable merging using labels in your Graphite merge queue settings. |
|
Current dependencies on/for this PR:
This stack of pull requests is managed by Graphite. |
codiumai-pr-agent-pro
bot
added
enhancement
and removed
app:electron
|
PR Description updated to latest commit (f2d6f67)
|
PR Review
✨ Review tool usage guide:Overview: With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Improve tool usage guide:Overview: With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
☁️ Nx Cloud ReportCI is running/has finished running commands for commit c724b3f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 6 targets
Sent with 💌 from NxCloud. |
CI Failure Feedback(Checks updated until commit d00f575)
✨ CI feedback usage guide:The CI feedback tool (
In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR: where Configuration options
See more information about the |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## canary #5922 +/- ##
=======================================
Coverage 63.96% 63.96%
=======================================
Files 364 364
Lines 20035 20035
Branches 1713 1713
=======================================
Hits 12815 12815
Misses 7001 7001
Partials 219 219
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Persistent checks updated to latest commit f2d6f67 |
1 similar comment
|
Persistent checks updated to latest commit f2d6f67 |
Brooooooklyn
force-pushed
the
fix/dmg-build
branch
from
f2d6f67
to
03d26a0
Compare
|
Persistent checks updated to latest commit 03d26a0 |
Brooooooklyn
force-pushed
the
fix/dmg-build
branch
from
03d26a0
to
a973751
Compare
|
Persistent checks updated to latest commit a973751 |
7 similar comments
|
Persistent checks updated to latest commit a973751 |
|
Persistent checks updated to latest commit a973751 |
|
Persistent checks updated to latest commit a973751 |
|
Persistent checks updated to latest commit a973751 |
|
Persistent checks updated to latest commit a973751 |
|
Persistent checks updated to latest commit a973751 |
|
Persistent checks updated to latest commit a973751 |
Brooooooklyn
force-pushed
the
fix/dmg-build
branch
from
a973751
to
d00f575
Compare
|
Persistent checks updated to latest commit d00f575 |
1 similar comment
|
Persistent checks updated to latest commit d00f575 |
pengx17
approved these changes
Feb 27, 2024
darkskygit
approved these changes
Feb 27, 2024
Merge activity
|
## **Type**
enhancement
___
## **Description**
- Introduced a custom DMG packaging solution `@affine/appdmg-patch` for Electron applications.
- Implemented a new TypeScript class `MakerDmg` to handle the custom packaging logic, including support for custom backgrounds, icons, and app positioning within the DMG.
- Updated Electron Forge configuration to use the new `@affine/appdmg-patch` package instead of `@electron-forge/maker-dmg`.
- Adjusted package dependencies in `packages/frontend/electron/package.json`, adding `@affine/appdmg-patch` and removing `@electron-forge/maker-dmg`.
___
## **Changes walkthrough**
<table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Enhancement
</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>index.ts</strong><dd><code>Implement Custom DMG Packaging Logic</code> </dd></summary>
<hr>
tools/appdmg-patch/index.ts
<li>Introduced a new class <code>MakerDmg</code> extending <code>MakerBase</code> with support for <br>custom DMG packaging.<br> <li> Implemented custom DMG packaging logic including background, icon, and <br>app positioning.<br> <li> Added support for custom <code>contents</code> configuration to define the DMG <br>layout.<br>
</details>
</td>
<td><a href="https://pull/5922/files#diff-96a537c04a2a740dca542688b3e6a65c67e6cf339b146bf0a9c49008ad58ea77">+80/-0</a> </td>
</tr>
</table></td></tr><tr><td><strong>Configuration changes
</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>forge.config.mjs</strong><dd><code>Update Electron Forge Configuration for Custom DMG Packaging</code></dd></summary>
<hr>
packages/frontend/electron/forge.config.mjs
<li>Replaced <code>@electron-forge/maker-dmg</code> with <code>@affine/appdmg-patch</code> in the <br>makers configuration.<br> <li> Adjusted DMG icon size and background configuration.<br>
</details>
</td>
<td><a href="https://pull/5922/files#diff-bd3343a702deabb8f5f6f77e34fbc215615538875f59b68d82612c0f5ed532a3">+2/-3</a> </td>
</tr>
<tr>
<td>
<details>
<summary><strong>package.json</strong><dd><code>Introduce Package Configuration for Custom DMG Packaging</code> </dd></summary>
<hr>
tools/appdmg-patch/package.json
<li>Created a new package <code>@affine/appdmg-patch</code> with necessary dependencies <br>for custom DMG packaging.<br>
</details>
</td>
<td><a href="https://pull/5922/files#diff-395b189951512e67d55b0abc55a167f014f239f608ec5b180f9c7d48e1ea9e8b">+16/-0</a> </td>
</tr>
</table></td></tr><tr><td><strong>Dependencies
</strong></td><td><table>
<tr>
<td>
<details>
<summary><strong>package.json</strong><dd><code>Update Package Dependencies for Electron Frontend</code> </dd></summary>
<hr>
packages/frontend/electron/package.json
<li>Added <code>@affine/appdmg-patch</code> to <code>devDependencies</code>.<br> <li> Removed <code>@electron-forge/maker-dmg</code> from <code>devDependencies</code>.<br>
</details>
</td>
<td><a href="https://pull/5922/files#diff-37323e9da5e4b1606abb6eb8e5ff1516ae5fce925bceaafeeade61bd80c0b62d">+1/-1</a> </td>
</tr>
</table></td></tr></tr></tbody></table>
___
> ✨ **PR-Agent usage**:
>Comment `/help` on the PR to get a list of all available PR-Agent tools and their descriptions
darkskygit
force-pushed
the
fix/dmg-build
branch
from
d00f575
to
c724b3f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type
enhancement
Description
@affine/appdmg-patchfor Electron applications.MakerDmgto handle the custom packaging logic, including support for custom backgrounds, icons, and app positioning within the DMG.@affine/appdmg-patchpackage instead of@electron-forge/maker-dmg.packages/frontend/electron/package.json, adding@affine/appdmg-patchand removing@electron-forge/maker-dmg.Changes walkthrough
index.ts
Implement Custom DMG Packaging Logictools/appdmg-patch/index.ts
MakerDmgextendingMakerBasewith support forcustom DMG packaging.
app positioning.
contentsconfiguration to define the DMGlayout.
forge.config.mjs
Update Electron Forge Configuration for Custom DMG Packagingpackages/frontend/electron/forge.config.mjs
@electron-forge/maker-dmgwith@affine/appdmg-patchin themakers configuration.
package.json
Introduce Package Configuration for Custom DMG Packagingtools/appdmg-patch/package.json
@affine/appdmg-patchwith necessary dependenciesfor custom DMG packaging.
package.json
Update Package Dependencies for Electron Frontendpackages/frontend/electron/package.json
@affine/appdmg-patchtodevDependencies.@electron-forge/maker-dmgfromdevDependencies.