Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: unify distribution file names #906

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Conversation

ShGKme
Copy link
Contributor

@ShGKme ShGKme commented Nov 18, 2024

☑️ Resolves

Currently, distribution (installer) file names are different from different packaging tools.
This PR unifies it in a format:

Nextcloud.Talk-<PLATFORM>-<ARCH>.ext

Where platform is renamed to a user-friendly name:

  • darwin => macos
  • win32 => windows

While it is cool to have a version in the file name, it makes it hard to have a constant link to the installer. The version is removed.

Examples:

  • Nextcloud.Talk-macos-universal.dmg
  • Nextcloud.Talk-windows-x64.exe
  • Nextcloud.Talk-windows-x64.msi
  • Nextcloud.Talk-linux-x64.flatpak
  • Nextcloud.Talk-linux-x64.zip

Implementation notes

All packagers have different output paths, incl. folder structure, and filenames.
In most of them, there is no option to specify or override it 😒

Hotfix: manually move files to the correct location.

Alternatives

  • create our own makers extending the original (doesn't always help)
  • fork @electron/forge makers, add features and upstream
  • Do not use electron-forge makers for distribution - use original tools directly

@ShGKme ShGKme added 2. developing distribution 📦 Building, packaging, publishing labels Nov 18, 2024
@ShGKme ShGKme self-assigned this Nov 18, 2024
Signed-off-by: Grigorii K. Shartsev <[email protected]>
@ShGKme ShGKme force-pushed the build/align-package-names branch from 86b1d4a to 8c8b5c1 Compare November 19, 2024 17:34
@ShGKme ShGKme requested a review from nickvergessen November 19, 2024 17:37
@ShGKme ShGKme marked this pull request as ready for review November 19, 2024 17:37
@@ -18,7 +18,7 @@ require('dotenv').config()
const CONFIG = {
// General
applicationName: packageJSON.productName,
applicationNameSanitized: packageJSON.productName.replaceAll(' ', '-'),
applicationNameSanitized: packageJSON.productName.replaceAll(' ', '.'),
Copy link
Member

Choose a reason for hiding this comment

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

dash is a problem? Would prefer that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No. But I didn't like that space replacer and name parts separator are the same symbol 🐧

@nickvergessen nickvergessen merged commit 0a58b5c into main Nov 19, 2024
11 checks passed
@nickvergessen nickvergessen deleted the build/align-package-names branch November 19, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review distribution 📦 Building, packaging, publishing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants