Skip to content
New issue

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

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

Already on GitHub? # to your account

CI: Set Windows packaging to default to zip #101

Merged
merged 1 commit into from
Dec 18, 2023

Conversation

paulpv
Copy link
Contributor

@paulpv paulpv commented Nov 15, 2023

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:

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

@PatTheMav
Copy link
Member

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

@paulpv
Copy link
Contributor Author

paulpv commented Dec 4, 2023

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
Copy link
Member

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
Copy link
Member

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

@paulpv paulpv changed the title CI: Have Windows always generate .zip and optionally package .msi CI: Change Windows packaging to generate ZIP archives by default Dec 11, 2023
@paulpv
Copy link
Contributor Author

paulpv commented Dec 11, 2023

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

@PatTheMav
Copy link
Member

@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 paulpv force-pushed the windows_package_and_zip branch from 6a93e50 to caaaaa9 Compare December 11, 2023 23:50
@paulpv
Copy link
Contributor Author

paulpv commented Dec 12, 2023

@PatTheMav Sorry. Fixed.

@PatTheMav
Copy link
Member

@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 paulpv force-pushed the windows_package_and_zip branch from caaaaa9 to 8ed5668 Compare December 12, 2023 23:01
@paulpv
Copy link
Contributor Author

paulpv commented Dec 12, 2023

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

@paulpv paulpv changed the title CI: Change Windows packaging to generate ZIP archives by default CI: Set Windows packaging to default to zip Dec 12, 2023
@PatTheMav
Copy link
Member

PatTheMav commented Dec 13, 2023

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.

The current code either packages a .msi **or** generates a .zip.
Many users prefer the zip, especially for portable installs.
A zip also mitigates code signing warnings.
This change always generates the .zip file.
If `-BuildInstaller` is specified then it will also build a .msi file.
@paulpv paulpv force-pushed the windows_package_and_zip branch from 8ed5668 to 59a85c4 Compare December 13, 2023 00:04
@paulpv
Copy link
Contributor Author

paulpv commented Dec 13, 2023

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!
image
(NOTE their horrible non-monospaced font!)

@PatTheMav
Copy link
Member

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

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants