Skip to content

Clarify documented behavior of versioned manifest files in usage docs #8462

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
Apr 8, 2025

Conversation

stmontgomery
Copy link
Contributor

This updates and clarifies the Version-specific Manifest Selection section of the usage documentation to clarify the behavior when having either newer or older tools versions.

Motivation:

In general, when using the versioned manifest feature, it's preferable to have the unversioned Package.swift represent the newest-supported tools version, and only use version-specific manifest files for older versions. This provides a better workflow because it allows you to more easily drop support for older versions when ready (by avoiding the need to modify the unversioned file), among other benefits.

Modifications:

  • "Reverse" the example shown in this documentation by having the unversioned file be newest.
  • Modernize the version numbers shown in examples.
  • Fix some non-inclusive language usages.
  • Add a footnote with some helpful historical context, and giving a recommendation.

@stmontgomery
Copy link
Contributor Author

@swift-ci please test

@bkhouri
Copy link
Contributor

bkhouri commented Apr 8, 2025

@swift-ci test self hosted windows

Copy link
Member

@dschaefer2 dschaefer2 left a comment

Choose a reason for hiding this comment

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

Thanks Stuart!

@stmontgomery stmontgomery enabled auto-merge (squash) April 8, 2025 20:29
@stmontgomery
Copy link
Contributor Author

@swift-ci smoke test macOS

@stmontgomery stmontgomery merged commit d4368fe into swiftlang:main Apr 8, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation package manifests changes to package manifest APIs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants