Skip to content

WiX: add educational notes to the windows packaging #391

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

Merged
merged 1 commit into from
Feb 24, 2025

Conversation

compnerd
Copy link
Member

This packages up the educational notes for distribution with the toolchain. It is yet unclear if this should be broken out into an optioanl MSI to allow installation of the documentation on demand rather than as an always available option. This should at least ensure that we distribute the user facing documentation that can be accessed from the compiler.

This packages up the educational notes for distribution with the
toolchain. It is yet unclear if this should be broken out into an
optioanl MSI to allow installation of the documentation on demand rather
than as an always available option. This should at least ensure that we
distribute the user facing documentation that can be accessed from the
compiler.
@compnerd
Copy link
Member Author

@compnerd compnerd merged commit 406d44b into swiftlang:release/6.1 Feb 24, 2025
@compnerd compnerd deleted the edunotes61 branch February 24, 2025 05:42
@DougGregor
Copy link
Member

Is there no way to do globbing on *.md within that directory?

@compnerd
Copy link
Member Author

I find that the explicit listing is better, and more importantly, the globbing really does cause a lot of upgrade issues. We currently only glob in two places, and both of them have been where we have always seen issues with users. The problem is that globbing interferes with the natural deterministic hashing and so we really should prefer to explicitly list everything if possible.

@DougGregor
Copy link
Member

Hmm. My actual goal here is to avoid having to do paired commits to the swift and swift-installer-scripts repositories for each educational note. Can we somehow ingest a file from the swift repository?

@compnerd
Copy link
Member Author

That would greatly increase build times for us due to the size of the swift repository. Can we ingest a file from the installer scripts in the swift repository instead?

@compnerd
Copy link
Member Author

BTW, to your point of

My actual goal here is to avoid having to do paired commits to the swift and swift-installer-scripts repositories for each educational note.

I don't think that they have to be paired - you can commit the changes in swift first and then come back and do this afterwards. In fact, that is better - that ensures that the file is staged, before we start distributing it.

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.

3 participants