CI: Set Windows packaging to default to zip

paulpv commented 9 months ago

Description

Change Package-Windows.ps1 from:

if ( ( $BuildInstaller ) ) {
  // package .msi
} else {
  // generate .zip
}

to

// generate .zip
if ( ( $BuildInstaller ) ) {
  // package .msi
}

Motivation and Context

The current code either packages a .msi or generates a .zip.
Many users prefer the zip (and it has the benefit of mitigating code signing warnings).
This change always generates the .zip file.
If -BuildInstaller is also specified then is also builds a .msi.

How Has This Been Tested?

.github/scripts/Build-Windows.ps1 -SkipDeps && .github/scripts/Package-Windows.ps1 -BuildInstaller outputs both .zip and .msi .github/scripts/Build-Windows.ps1 -SkipDeps && .github/scripts/Package-Windows.ps1 outputs .zip

Types of changes

Tweak (non-breaking change to improve existing functionality)

Do we need to document any changes in this PR, or a future one?

Checklist:

[x] My code has been run through clang-format.
[x] I have read the contributing document.
[x] My code is not on the master branch.
[x] The code has been tested.
[x] All commit messages are properly formatted and commits squashed where appropriate.
[x] I have included updates to all appropriate documentation.

PatTheMav commented 9 months ago

I guess this is a specific "Windows-ism" to release an installer and a simple archive side-by-side?

paulpv commented 9 months ago

I guess this is a specific "Windows-ism" to release an installer and a simple archive side-by-side?

Yes, obs-ndi has several users saying they won't use a MSI/exe installer and only want the zip to manually install with. Mostly related to portable installs.

Seemed like a legit request to me.

We used to drop both MSI and zip that people got used to before we converted over to using obs-plugintemplate which lost the ability to drop both.

Do you think this PR needs to update the readme any, or can I just check the checkbox that there is no need to update any documentation?

PatTheMav commented 9 months ago

If there is no need to update any documentation that it should be by definition still "up-to-date". I haven't checked the readme with regards to any mentions of the kind of release artefacts that are generated though.

PatTheMav commented 9 months ago

Please rename the commit message to something like CI: Change Windows packaging to generate ZIP archives by default

paulpv commented 9 months ago

@PatTheMav Renamed. I also checked and do not see any documentation of files dropped so no need to update any existing documentation.

PatTheMav commented 8 months ago

@PatTheMav Renamed. I also checked and do not see any documentation of files dropped so no need to update any existing documentation.

You changed the PR title but I asked for the commit message to be changed.

paulpv commented 8 months ago

@PatTheMav Sorry. Fixed.

PatTheMav commented 8 months ago

@PatTheMav Sorry. Fixed.

Alas your commit message still has lines that are too long - you checked the box that you read the contribution guidelines, so please read them again and format your commit message accordingly.

paulpv commented 8 months ago

@PatTheMav Again, sorry. Took your suggestion literally and didn't realize it was over the limit.

PatTheMav commented 8 months ago

Still over the limit 😅

Also avoid Markdown in commit messages, it is a GitHub-specific quirk that formatting might be applied, but we aim commit messages to be vendor-agnostic.

paulpv commented 8 months ago

Still over the limit 😅

Also avoid Markdown in commit messages, it is a GitHub-specific quirk that formatting might be applied, but we aim commit messages to be vendor-agnostic.

@PatTheMav SO SORRY! :) I am going to put a feature request into GitKraken to add a column width indicator to BOTH the commit description and the message! (NOTE their horrible non-monospaced font!)

PatTheMav commented 8 months ago

That’s painful - give Sublime Merge a try, I wouldn’t use anything else anymore. 😉

obsproject / obs-plugintemplate