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

Add package validation to NuGet publishing (OSOE-176) #45

Closed
Piedone opened this issue Aug 22, 2022 · 1 comment · Fixed by #49
Closed

Add package validation to NuGet publishing (OSOE-176) #45

Piedone opened this issue Aug 22, 2022 · 1 comment · Fixed by #49
Assignees
Labels
enhancement New feature or request

Comments

@Piedone
Copy link
Member

Piedone commented Aug 22, 2022

The .NET SDK has package validation, which are useful checks when you publish your NuGet package. Let's utilize them, and configure them how we see them suitable.

  • Baseline version validator:
    • We already have the previous version lookup code in the publish-nuget action to get the baseline version. This needs to compare against the latest release (i.e. not pre-release/alpha) version. Note that there might not be a previous release yet, in which case this validation shouldn't run.
    • What to do during alpha releases, releases for issues? Breaking changes should still be tackled, but we need to be able to accept them. The CompatibilitySuppressions.xml file is good for this, but this also needs to be automatically removed upon a major release (i.e. when we may introduce breaking changes).
  • Compatible runtime validator looks good as it is.
  • Compatible framework validator looks good as it is.
  • Do everything from the CLI if possible, without the need to modify csprojs.
@Piedone Piedone added the enhancement New feature or request label Aug 22, 2022
@Piedone Piedone self-assigned this Sep 7, 2022
@Piedone
Copy link
Member Author

Piedone commented Sep 8, 2022

Didn't use Baseline version validator in the workflow in the end. It would require constant maintenance of the suppression file. Instead, documented to run it prior to selecting the next version number.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant