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

Packaging enhancements #32

Merged
merged 17 commits into from
May 22, 2024
Merged

Packaging enhancements #32

merged 17 commits into from
May 22, 2024

Conversation

SleepyLeslie
Copy link
Collaborator

@SleepyLeslie SleepyLeslie commented May 18, 2024

  • Adds Windows portable build - partly addresses Portable grist on Windows and simple configuration. #27.
  • Packaging pipeline now produces artifacts for inspection.
  • Windows x86 build is back!
  • node_modules is now cached, saving 3min30s of build time and an additional 2min for Windows x86 builds.
  • Cleaned up workflows.

@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch 2 times, most recently from 6a1ad55 to fdef5ec Compare May 18, 2024 06:05
@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch from adc7f7d to dd6bf30 Compare May 18, 2024 06:26
@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch 2 times, most recently from fa8a7aa to 520f15b Compare May 18, 2024 07:15
@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch from 520f15b to cb01a08 Compare May 18, 2024 07:20
@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch from 954c6b7 to 7c8167e Compare May 18, 2024 18:20
@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch from 5fcfd60 to ebb6479 Compare May 20, 2024 19:24
@SleepyLeslie SleepyLeslie force-pushed the sleepyleslie/packaging-enhance branch from ebb6479 to 1d4d4b8 Compare May 20, 2024 19:26
@SleepyLeslie SleepyLeslie changed the title Add Windows portable build Packaging enhancements May 20, 2024
@SleepyLeslie SleepyLeslie requested a review from Spoffy May 20, 2024 20:05
Copy link
Member

@paulfitz paulfitz left a comment

Choose a reason for hiding this comment

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

Looking good overall, thanks @SleepyLeslie. Some questions.

@@ -29,9 +29,6 @@ jobs:
with:
submodules: true

- name: check bash
Copy link
Member

Choose a reason for hiding this comment

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

Why is this check removed? It was checking something pretty subtle and weird but I see there are no comments as to what exactly :)

Copy link
Member

Choose a reason for hiding this comment

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

(Not against removing, just checking why)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I looked at the code and couldn't understand why this check needs to be present. It was doing no useful work (basically if true; then echo ok; fi then repeat for another time), and there was no comment to explain its significance. I thought it was legacy leftovers not cleaned up. I double checked my CI and packaging runs and this step never failed (I would be surprised if it did). My guess is it might be checking whether the Windows association step worked (script is run with bash rather than powershell), and was likely added for debugging purposes, so I removed it. If anything breaks in the future I can always come back to it.
Please do share any extra context you have on what the problem was.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it was likely something like that, figuring out the association, and that a good version of bash was running. Doing bash-like stuff in windows was delicate, and I could easily imagine it breaking in future again. Still, since these checks have no comments, fine to remove them. Thanks for explaining.

.github/workflows/package.yml Show resolved Hide resolved
.github/workflows/package.yml Show resolved Hide resolved
.github/workflows/package.yml Outdated Show resolved Hide resolved
.github/workflows/package.yml Show resolved Hide resolved
package.json Show resolved Hide resolved
@@ -108,9 +121,6 @@
"role": "Editor",
"icon": "core/static/icons/gristdoc"
}
],
"nsis": {
"perMachine": true
Copy link
Member

Choose a reason for hiding this comment

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

Do you know what this was?

Copy link
Collaborator Author

@SleepyLeslie SleepyLeslie May 22, 2024

Choose a reason for hiding this comment

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

According to this documentation, this option does nothing when oneClick is true (default, we didn't change it), so I removed it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

FYI otherwise this option tells NSIS to skip the installation mode page and always installs Grist Desktop system-wide. This might not be a good idea in restricted environments where user does not have admin privileges, but we now have the portable build so this shouldn't matter much?

Copy link
Member

Choose a reason for hiding this comment

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

Pretty sure this was the hard-to-find solution to some gnarly problem, but we shouldn't keep it out of superstition. Someone will shout if it turns out to have some effect that was important, and then we can document the reason better next time :-). Cheers.

Copy link
Member

@paulfitz paulfitz left a comment

Choose a reason for hiding this comment

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

Thanks @SleepyLeslie ! Good to land.

@@ -29,9 +29,6 @@ jobs:
with:
submodules: true

- name: check bash
Copy link
Member

Choose a reason for hiding this comment

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

Yes, it was likely something like that, figuring out the association, and that a good version of bash was running. Doing bash-like stuff in windows was delicate, and I could easily imagine it breaking in future again. Still, since these checks have no comments, fine to remove them. Thanks for explaining.

@@ -108,9 +121,6 @@
"role": "Editor",
"icon": "core/static/icons/gristdoc"
}
],
"nsis": {
"perMachine": true
Copy link
Member

Choose a reason for hiding this comment

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

Pretty sure this was the hard-to-find solution to some gnarly problem, but we shouldn't keep it out of superstition. Someone will shout if it turns out to have some effect that was important, and then we can document the reason better next time :-). Cheers.

@SleepyLeslie SleepyLeslie merged commit ad72de7 into main May 22, 2024
1 check passed
@SleepyLeslie SleepyLeslie deleted the sleepyleslie/packaging-enhance branch July 11, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants