KEMBAR78
Adds Cargo package validation by kennykerr · Pull Request #3714 · microsoft/windows-rs · GitHub
Skip to content

Conversation

@kennykerr
Copy link
Collaborator

As the number of crates in the repo has grown, it has become a bit more tedious to ensure that all of the package fields are consistent and correct. This update just adds a simple test crate that validates some of the most important package manifest settings for consistency and correctness. Notably, it checks the following:

  • There should not be an authors field as that is deprecated
  • The edition should be 2021
  • The license should be "MIT OR Apache-2.0"
  • The repository should be "https://github.com/microsoft/windows-rs"
  • The readme should be "readme.md" as Cargo assumes "README.md"
  • The categories should be "os::windows-apis"
  • There should be a non-empty description.
  • Unpublished crates (samples/tests/tools) should omit most fields including version, license, repository, readme, categories, and description

@kennykerr kennykerr changed the title Adds basic Cargo package validation Adds Cargo package validation Aug 13, 2025
@kennykerr
Copy link
Collaborator Author

Sigh, older versions of Cargo still require the version field.

@kennykerr kennykerr merged commit 2d39427 into master Aug 13, 2025
29 checks passed
@kennykerr kennykerr deleted the test-package branch August 13, 2025 21:38
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.

1 participant