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

Standardize release asset naming #3123

Open
X9VoiD opened this issue Dec 22, 2023 · 3 comments
Open

Standardize release asset naming #3123

X9VoiD opened this issue Dec 22, 2023 · 3 comments
Labels
enhancement New feature or request priority:high High priority issue/pull request
Milestone

Comments

@X9VoiD
Copy link
Member

X9VoiD commented Dec 22, 2023

Original (from CI):
image

Renamed (as seen on release):
image

Historically, we're doing this rename for OpenTabletDriver.Web. We don't have to anymore and we can start using the original filenames once opentabletdriver.github.io#139 is resolved.

But we can do better.

I'm proposing we use the following rules/convention for naming release assets:

  • Use the platform/distro's convention when it exists,
  • Else, use opentabletdriver.<platform>.<version>-<arch>.<ext>, where:
    • platform is win, macos, or linux, this is optional for linux packages.
    • arch is x86_64, or arm64.
@github-actions github-actions bot added the needs-triage This issue or PR has not been properly labeled yet label Dec 22, 2023
@gonX gonX added enhancement New feature or request and removed needs-triage This issue or PR has not been properly labeled yet labels Jan 2, 2024
@gonX
Copy link
Member

gonX commented Jan 2, 2024

I agree with this, however I would have to see some examples of "use the platform/distro's convention when it exists" - would all of them not fit into the "extension" part of your suggested formatting?

@gonX
Copy link
Member

gonX commented Jan 2, 2024

I got a bit ahead of myself there. The name used for Fedora is a good example of what I was asking about: opentabletdriver-0.6.4.0-1.x86_64.rpm

To take inspiration from this, maybe use opentabletdriver.<platform>.<version>.<arch>.<ext>? It replaces -<arch> with .<arch>. The only downside I see with this is that it might be confusing for people hiding file extensions (making the Windows .exe look like a .x86_64 file)

I prefer not to include pkgrel (the -1 in 0.6.4.0-1), as any packaging updates for these packages would likely have to be fixed by a new minor release anyway, or for the rare occasion that it doesn't need a new release, the old file should be replaced with a fixed version - but if nothing else, I am not completely locked on this idea.

@X9VoiD
Copy link
Member Author

X9VoiD commented Jan 28, 2024

I agree with dropping the pkgrel. How about opentabletdriver.<platform>-<version>.<arch>.<ext>? If we have no clear preference then let's use this one.

related issue comment: OpenTabletDriver/opentabletdriver.github.io#139 (comment)

@gonX gonX added this to the v0.6.5.1 milestone Dec 18, 2024
@gonX gonX added the priority:high High priority issue/pull request label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority:high High priority issue/pull request
Projects
None yet
Development

No branches or pull requests

2 participants