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

OSOE-864: Automatically check baseline package validation during review in Lombiq.GitHub.Actions #874

Merged
merged 11 commits into from
Nov 4, 2024
8 changes: 2 additions & 6 deletions NuGetTest/Directory.Build.props
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
<Project>
<PropertyGroup>
<NuGetTestbed>true</NuGetTestbed>
<UseGlobalNodeJsExtensionsNpmPackage>false</UseGlobalNodeJsExtensionsNpmPackage>
<NodeJsExtensionsNpmPackageSourcePath></NodeJsExtensionsNpmPackageSourcePath>
<!-- Instruct Node.js Extensions to create .eslintrc and .stylelintrc files in the parent directory, which is the
OSOCE root directory. -->
<NodeJsExtensionsGlobalESLintConfigurationDirectory>$(MSBuildThisFileDirectory)..</NodeJsExtensionsGlobalESLintConfigurationDirectory>
<NodeJsExtensionsGlobalStylelintConfigurationDirectory>$(MSBuildThisFileDirectory)..</NodeJsExtensionsGlobalStylelintConfigurationDirectory>
<UseGlobalNodeJsExtensionsNpmPackage>true</UseGlobalNodeJsExtensionsNpmPackage>
<NodeJsExtensionsNpmPackageSourcePath>$(MSBuildThisFileDirectory)node_modules/.nx</NodeJsExtensionsNpmPackageSourcePath>
</PropertyGroup>

<ItemGroup>
Expand Down
5 changes: 5 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ When adding a new extension, or significant new features to existing extensions,
- Open a pull request in this repository for every submodule pull request. That way, static code analysis and complex tests can run. If you forget to do so, a check in the submodule will fail. Once you've created the PR here, just click "Re-run jobs" in your submodule.
- If you see build errors under your pull request then check out its details: It will send you to the failed step in the Actions tab. You can also click on the "Summary" on the sidebar to download the artifacts (logs, screenshots, etc) and in case of failed UI tests you find the annotations linking to which test failed.
- Open a pull request for all but trivial changes (like typos) so we can nicely track them, including when generating release notes for the next release.
- If you introduce breaking changes, the Validate NuGet Publish workflow will fail due to [baseline package validation](https://learn.microsoft.com/en-us/dotnet/fundamentals/apicompat/package-validation/baseline-version-validator). Preferably, adjust the change to not be breaking if possible; if it has to be a breaking change, then you’ll need to create a _CompatibilitySuppressions.xml_ file to mark it as deliberate, what you can do with the following command:

```powershell
dotnet pack /p:EnablePackageValidation=true /p:PackageValidationBaselineVersion=<current version> /p:Version=<new version> /p:NuGetBuild=true /p:GenerateCompatibilitySuppressionFile=true
```

### Dependencies between Lombiq projects

Expand Down
Loading