Build name convention standardization #6423

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-12-20T17:31:47Z

Build name convention standardization

Pull Request Type

Bugfix
Feature Implementation
Documentation
Other

Related issue

#6415

Description

This PR changes the following:

We were using a mix match of hyphens and underscores so this changes all builds to use hyphens instead of underscores. Why hyphens? Most release builds were using hyphens and for nightly builds it was about 50/50 so i opted for hyphens as most normal users (the ones that use release builds) are used to seeing hyphens. Certain platforms have their own naming conventions (e.g. .deb and .rpm) when thats the case we will use those conventions.
Some build names didnt include the .zip extension so i added them
if file name contains portable then the following structure is used, platform-architecture-portable. There was a mix of this structure and platform-portable-architecture being used.
all zip and 7z builds include portable in the name now except macos builds

Additional context

I will create a PR for our website that will pull the now adjusted release builds. That PR will be drafted as it should be merged right before release.

This is part 2 of making changes in these workflow.
Upcoming parts:

Part 3: Group all builds based on platform
~~Part 4: Investigate if all builds have .zip and .7z equivalents~~

absidue · 2024-12-20T17:44:44Z

We should probably stick with underscores for the artifacts that electron-builder also uses underscores e.g. the deb files where using underscores to separate the name, version and architecture in the deb file name is a convention .

…convention

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-12-22T19:20:42Z

Applied standard naming conventions where it wasnt being applied before.

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-12-23T01:11:40Z

applied WIP as it still need some more changes

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-12-28T01:29:10Z

ready for review!

.github/workflows/build.yml

PikachuEXE · 2024-12-28T01:34:48Z

.github/workflows/build.yml

@@ -322,26 +322,26 @@ jobs:
      uses: actions/upload-artifact@v4
      if: startsWith(matrix.os, 'macos') && startsWith(matrix.runtime, 'osx-x64')
      with:
-        name: freetube-${{ steps.versionNumber.outputs.result }}-mac-x64.zip
+        name: freetube-${{ steps.versionNumber.outputs.result }}-mac-x64-portable.zip


Not objecting this but I found that projects rarely got portable suffix to zips & dmg for mac
But it's still fine to be extra clear

I can revert it if you want. I only added this because some of our portable builds did have it and others not

Ya I think it's better to revert.
There is no portable concept for macOS apps (mostly). The data is stored in user directory anyway.
I would even argue that the windows one isn't portable as well. Since the data isn't stored inside the same folder as the app folder (and no way to change that). It's just another way of installation but the data isn't "portable".

I will revert it for macOS

I would even argue that the windows one isn't portable as well. Since the data isn't stored inside the same folder as the app folder (and no way to change that). It's just another way of installation but the data isn't "portable".

A conversation i had before opening this PR

ChunkyProgrammer

Note: these changes could break some workflows for some of the unofficial downloads.

We should probably notify the maintainer of the PortableApps version of FreeTube that this change was made as well as other maintainers of unofficial downloads if we think their workflow might need to be modified for these changes

.github/workflows/release.yml

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-12-29T18:37:58Z

Note: these changes could break some workflows for some of the unofficial downloads.

We should probably notify the maintainer of the PortableApps version of FreeTube that this change was made as well as other maintainers of unofficial downloads if we think their workflow might need to be modified for these changes

@ChunkyProgrammer i have notified all maintainers of the unofficial downloads through GH/email except for WAPT (not sure how to properly contact the package maintainer) and Homebrew (i think this is Pika though)

ryand56 · 2024-12-30T01:14:41Z

Thanks for letting us know about the changes, though no changes will be needed on our end as we are building from source now.

PikachuEXE · 2024-12-30T01:16:39Z

My homebrew tab also builds from source = not relying on those names
https://github.com/PikachuEXE/homebrew-FreeTube/blob/master/.github/workflows/release-manual-trigger.yml

rddim · 2024-12-30T15:46:47Z

@ChunkyProgrammer and @efb4f5ff-1298-471a-8973-3d47447115dc

Thank you very much for the notification. I'm not affected from the new changes because I use the only the final releases.

efb4f5ff-1298-471a-8973-3d47447115dc · 2024-12-31T00:07:40Z

Are there still things that we need to consider? Are there maybe some reservations about this PR that i can address?

absidue

We'll need to remember to update the files in the flathub repo that reference the linux zip files.

efb4f5ff-1298-471a-8973-3d47447115dc · 2025-01-01T22:21:43Z

We'll need to remember to update the files in the flathub repo that reference the linux zip files.

Im on it!

* standardize names for builds * use .deb and .rpm standard pkg name convention * include portable in name for 7z and zip builds * revert portable naming for mac builds * change names in flatpak workflow

standardize names for builds

26984e1

FreeTubeBot enabled auto-merge (squash) December 20, 2024 17:32

github-actions bot added the PR: waiting for review For PRs that are complete, tested, and ready for review label Dec 20, 2024

efb4f5ff-1298-471a-8973-3d47447115dc requested review from PikachuEXE, absidue, ChunkyProgrammer, kommunarr and MarmadileManteater December 20, 2024 17:41

Merge branch 'FreeTubeApp:development' into standardize-build-naming-…

f166042

…convention

efb4f5ff-1298-471a-8973-3d47447115dc added PR: changes requested and removed PR: waiting for review For PRs that are complete, tested, and ready for review labels Dec 20, 2024

use .deb and .rpm standard pkg name convention

04bcda4

efb4f5ff-1298-471a-8973-3d47447115dc added PR: waiting for review For PRs that are complete, tested, and ready for review and removed PR: changes requested labels Dec 22, 2024

efb4f5ff-1298-471a-8973-3d47447115dc added PR: WIP and removed PR: waiting for review For PRs that are complete, tested, and ready for review labels Dec 22, 2024

include portable in name for 7z and zip builds

2ad237d

efb4f5ff-1298-471a-8973-3d47447115dc added PR: waiting for review For PRs that are complete, tested, and ready for review and removed PR: WIP labels Dec 28, 2024

PikachuEXE reviewed Dec 28, 2024

View reviewed changes

revert portable naming for mac builds

3e734ee

ChunkyProgrammer reviewed Dec 28, 2024

View reviewed changes

.github/workflows/release.yml Show resolved Hide resolved

ChunkyProgrammer added the PR: changes requested label Dec 28, 2024

change names in flatpak workflow

58bfde3

efb4f5ff-1298-471a-8973-3d47447115dc removed the PR: waiting for review For PRs that are complete, tested, and ready for review label Dec 29, 2024

efb4f5ff-1298-471a-8973-3d47447115dc requested a review from ChunkyProgrammer December 29, 2024 17:18

efb4f5ff-1298-471a-8973-3d47447115dc requested a review from PikachuEXE December 29, 2024 17:18

efb4f5ff-1298-471a-8973-3d47447115dc added PR: waiting for review For PRs that are complete, tested, and ready for review and removed PR: changes requested labels Dec 30, 2024

absidue approved these changes Jan 1, 2025

View reviewed changes

PikachuEXE approved these changes Jan 1, 2025

View reviewed changes

kommunarr approved these changes Jan 1, 2025

View reviewed changes

FreeTubeBot merged commit 8c33113 into FreeTubeApp:development Jan 1, 2025
5 checks passed

github-actions bot removed the PR: waiting for review For PRs that are complete, tested, and ready for review label Jan 1, 2025

efb4f5ff-1298-471a-8973-3d47447115dc deleted the standardize-build-naming-convention branch January 1, 2025 22:22

This was referenced Jan 2, 2025

Group Release and Nightly builds #6497

Merged

Rename Release build names FreeTubeApp/FreeTubeApp.io#54

Merged

Rename build names flathub/io.freetubeapp.FreeTube#123

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build name convention standardization #6423

Build name convention standardization #6423

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 20, 2024 •

edited

Loading

absidue commented Dec 20, 2024 •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 22, 2024

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 23, 2024 •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 28, 2024

PikachuEXE Dec 28, 2024

efb4f5ff-1298-471a-8973-3d47447115dc Dec 28, 2024

PikachuEXE Dec 28, 2024

efb4f5ff-1298-471a-8973-3d47447115dc Dec 28, 2024 •

edited

Loading

ChunkyProgrammer left a comment •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 29, 2024 •

edited

Loading

ryand56 commented Dec 30, 2024

PikachuEXE commented Dec 30, 2024

rddim commented Dec 30, 2024

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 31, 2024

absidue left a comment

efb4f5ff-1298-471a-8973-3d47447115dc commented Jan 1, 2025 •

edited

Loading

Build name convention standardization #6423

Build name convention standardization #6423

Conversation

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 20, 2024 • edited Loading

Build name convention standardization

Pull Request Type

Related issue

Description

Additional context

absidue commented Dec 20, 2024 • edited Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 22, 2024

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 23, 2024 • edited Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 28, 2024

PikachuEXE Dec 28, 2024

Choose a reason for hiding this comment

efb4f5ff-1298-471a-8973-3d47447115dc Dec 28, 2024

Choose a reason for hiding this comment

PikachuEXE Dec 28, 2024

Choose a reason for hiding this comment

efb4f5ff-1298-471a-8973-3d47447115dc Dec 28, 2024 • edited Loading

Choose a reason for hiding this comment

ChunkyProgrammer left a comment • edited Loading

Choose a reason for hiding this comment

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 29, 2024 • edited Loading

ryand56 commented Dec 30, 2024

PikachuEXE commented Dec 30, 2024

rddim commented Dec 30, 2024

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 31, 2024

absidue left a comment

Choose a reason for hiding this comment

efb4f5ff-1298-471a-8973-3d47447115dc commented Jan 1, 2025 • edited Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 20, 2024 •

edited

Loading

absidue commented Dec 20, 2024 •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 23, 2024 •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc Dec 28, 2024 •

edited

Loading

ChunkyProgrammer left a comment •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Dec 29, 2024 •

edited

Loading

efb4f5ff-1298-471a-8973-3d47447115dc commented Jan 1, 2025 •

edited

Loading