Skip to content

Commit

Permalink
Build a Nupkg without a .nuspec (#579)
Browse files Browse the repository at this point in the history 
* Enable dotnet pack without a .nuspec file

fixes #283

* Update readme

* Set package type

* avoid breaking change

* Update TestProject

* Remove property

* Move Pack item to Props

* Remove PackageType to fix VS NuGet restore issue

* Update readme

* Simpler

* Remove package type to avoid confusion

see NuGet/Home#10468
  • Loading branch information
@ErikEJ
ErikEJ authored Jul 15, 2024
1 parent a073e37 commit 2baa8f8
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 69 deletions.
71 changes: 24 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ dotnet new sqlproj -s Sql130
You should now have a project file with the following contents:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<SqlServerVersion>Sql130</SqlServerVersion>
Expand Down Expand Up @@ -94,7 +94,7 @@ If you already have a SSDT (.sqlproj) project in your solution, you can keep tha
There are a lot of properties that can be set on the model in the resulting `.dacpac` file which can be influenced by setting those properties in the project file using the same name. For example, the snippet below sets the `RecoveryMode` property to `Simple`:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<RecoveryMode>Simple</RecoveryMode>
Expand All @@ -112,7 +112,7 @@ Like `.sqlproj` projects `MSBuild.Sdk.SqlProj` supports controlling T-SQL build
Treating warnings as errors can be optionally enabled by adding a property `TreatTSqlWarningsAsErrors` to the project file:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TreatTSqlWarningsAsErrors>True</TreatTSqlWarningsAsErrors>
...
Expand All @@ -124,7 +124,7 @@ Treating warnings as errors can be optionally enabled by adding a property `Trea
To suppress specific warnings from being treated as errors, add a comma-separated list of warning codes to `SuppressTSqlWarnings` property in the project file:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<SuppressTSqlWarnings>71558,71502</SuppressTSqlWarnings>
<TreatTSqlWarningsAsErrors>True</TreatTSqlWarningsAsErrors>
Expand All @@ -136,7 +136,7 @@ To suppress specific warnings from being treated as errors, add a comma-separate
You can suppress warnings for a specific file by adding `SuppressTSqlWarnings` for this file:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
...
</PropertyGroup>
Expand All @@ -156,7 +156,7 @@ Support for pre- and post deployment scripts has been added in version 1.1.0. Th
To include these scripts into your `.dacpac` add the following to your `.csproj`:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
...
</PropertyGroup>
Expand All @@ -173,7 +173,7 @@ It is important to note that scripts in the `Pre-Deployment` and `Post-Deploymen
By default the pre- and/or post-deployment script of referenced packages (both [PackageReference](#package-references) and [ProjectReference](#project-references)) are not run when using `dotnet publish`. As of version 1.11.0 this can be optionally enabled by adding a property `RunScriptsFromReferences` to the project file as in the below example:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<RunScriptsFromReferences>True</RunScriptsFromReferences>
...
Expand All @@ -189,7 +189,7 @@ By default the pre- and/or post-deployment script of referenced packages (both [
Especially when using pre- and post deployment scripts, but also in other scenario's, it might be useful to define variables that can be controlled at deployment time. This is supported through the use of SQLCMD variables, added in version 1.1.0. These variables can be defined in your project file using the following syntax:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
...
</PropertyGroup>
Expand All @@ -213,7 +213,7 @@ Especially when using pre- and post deployment scripts, but also in other scenar
`MSBuild.Sdk.SqlProj` supports referencing NuGet packages that contain `.dacpac` packages. These can be referenced by using the `PackageReference` format familiar to .NET developers. They can also be installed through the NuGet Package Manager in Visual Studio.

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
Expand All @@ -227,7 +227,7 @@ Especially when using pre- and post deployment scripts, but also in other scenar
It will assume that the `.dacpac` file is inside the `tools` folder of the referenced package and that it has the same name as the NuGet package. Referenced packages that do not adhere to this convention will be silently ignored. However, you have the ability to override this convention by using the `DacpacName` attribute on the `PackageReference` (introduced in version 2.5.0). For example:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<SqlServerVersion>Sql160</SqlServerVersion>
Expand All @@ -244,7 +244,7 @@ This will add a reference to the `tools\SomeOtherDacpac.dacpac` file inside the
By default the package reference is treated as being part of the same database. For example, if the reference package contains a `.dacpac` that has a table and a stored procedure and you would `dotnet publish` the project the table and stored procedure from that package will be deployed along with the contents of your project to the same database. If this is not desired, you can add the `DatabaseVariableLiteralValue` item metadata to the `PackageReference` specifying a different database name:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
Expand All @@ -261,7 +261,7 @@ You can also use SQLCMD variables to set references, similar to the behavior of
>Note: Don't forget to define appropriate [SQLCMD variables](#sqlcmd-variables)
```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
Expand Down Expand Up @@ -302,7 +302,7 @@ sqlpackage
Microsoft has recently released NuGet packages containing the definitions of the `master` and `msdb` databases. This is useful if you want to reference objects from those databases within your own projects without getting warnings. To reference these, you'll need to use at least version 2.5.0 of MSBuild.Sdk.SqlProj as you'll need to use the `DacpacName` feature for package references described above. For example:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<SqlServerVersion>160</SqlServerVersion>
Expand All @@ -322,7 +322,7 @@ For other variants of SQL Server / Azure SQL Database there are dedicated packag
Similar to package references you can also reference another project by using a `ProjectReference`. These references can be added manually to the project file or they can be added through Visual Studio. For example, consider the following example:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
Expand All @@ -336,7 +336,7 @@ Similar to package references you can also reference another project by using a
This will ensure that `MyOtherProject` is built first and the resulting `.dacpac` will be referenced by this project. This means you can use the objects defined in the other project within the scope of this project. If the other project is representing an entirely different database you can also use `DatabaseVariableLiteralValue` or SQLCMD variables on the `ProjectReference` similar to `PackageReference`:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
Expand Down Expand Up @@ -370,7 +370,7 @@ In order to solve circular references between databases that may have been incor
`SuppressMissingDependenciesErrors` to both [Package References](#package-references) and [ProjectReferences](#project-references)):

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
Expand All @@ -386,41 +386,18 @@ In order to solve circular references between databases that may have been incor
```

## Packaging support
`MSBuild.Sdk.SqlProj` supports packaging your project into a [NuGet](https://www.nuget.org) package using the `dotnet pack` command. In order for this to work, you'll need to add a `.nuspec` file next to your project file with the same name. For example, if your `.csproj` is called `TestProject.csproj` you'll need to add a `TestProject.nuspec` file in the same folder. Fill this file with the following contents and replace the placeholder with the appropriate value:

```xml
<?xml version="1.0" encoding="utf-8" ?>
<package xmlns="http://schemas.microsoft.com/packaging/2011/10/nuspec.xsd">
<metadata>
<id>$id$</id>
<version>$version$</version>
<description>$description$</description>
<authors>$authors$</authors>
<owners>$authors$</owners>
<copyright>$copyright$</copyright>
<projectUrl>$projecturl$</projectUrl>
<tags>$tags$</tags>
<packageTypes>
<packageType name="$packagetype$" />
</packageTypes>
<repository type="git" url="<repository-url>" />
</metadata>
<files>
<file src="bin\$configuration$\$tfm$\*.dacpac" target="tools/" />
</files>
</package>
```

> Note: The above `.nuspec` file will result in a package that includes the .dacpac of the project as well as any referenced .dacpac file's (those from `PackageReference`). This is by design since you'll probably need those later on when deploying the .dacpac. If you want to only include the .dacpac of the project replace `*.dacpac` with `$id$.dacpac`.
`MSBuild.Sdk.SqlProj` version 2.8.0 and later supports packaging your project into a [NuGet](https://www.nuget.org) package using the `dotnet pack` command.

Additionally you'll need to set the `PackageProjectUrl` property inside of the `.csproj` like this:
You'll need to set the `PackageProjectUrl` property in the `.csproj` like this:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
...
<PackageProjectUrl>your-project-url</PackageProjectUrl>
</PropertyGroup>

</Project>
```

Expand Down Expand Up @@ -490,7 +467,7 @@ To further customize the deployment process, you can use the following propertie
In addition to these properties, you can also set any of the [documented](https://docs.microsoft.com/dotnet/api/microsoft.sqlserver.dac.dacdeployoptions) deployment options. These are typically set in the project file, for example:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
...
<BackupDatabaseBeforeChanges>True</BackupDatabaseBeforeChanges>
Expand All @@ -513,7 +490,7 @@ Most of those properties are simple values (like booleans, strings and integers)
Instead of using `dotnet publish` to deploy changes to a database, you can also have a full SQL script generated that will create the database from scratch and then run that script against a SQL Server. This can be achieved by adding the following to the project file:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<GenerateCreateScript>True</GenerateCreateScript>
<IncludeCompositeObjects>True</IncludeCompositeObjects>
Expand All @@ -539,7 +516,7 @@ Starting with version 2.7.0 of the SDK, there is support for running static code
Static code analysis can be enabled by adding the `RunSqlCodeAnalysis` property to the project file:

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<RunSqlCodeAnalysis>True</RunSqlCodeAnalysis>
<CodeAnalysisRules>-SqlServer.Rules.SRD0006;-Smells.*</CodeAnalysisRules>
Expand All @@ -556,7 +533,7 @@ Any rule violations found during analysis are reported as build warnings.
Individual rule violations or groups of rules can be configured to be reported as build errors as shown below.

```xml
<Project Sdk="MSBuild.Sdk.SqlProj/2.7.2">
<Project Sdk="MSBuild.Sdk.SqlProj/2.8.0">
<PropertyGroup>
<RunSqlCodeAnalysis>True</RunSqlCodeAnalysis>
<CodeAnalysisRules>+!SqlServer.Rules.SRN0005;+!SqlServer.Rules.SRD*</CodeAnalysisRules>
Expand Down
3 changes: 2 additions & 1 deletion src/MSBuild.Sdk.SqlProj/Sdk/Sdk.props
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<EnableDefaultCompileItems>false</EnableDefaultCompileItems>
<EnableDefaultEmbeddedResourceItems>false</EnableDefaultEmbeddedResourceItems>
<NoPackageAnalysis>True</NoPackageAnalysis>
<NuspecFile>$(MSBuildProjectName).nuspec</NuspecFile>
<NuspecFile Condition="Exists('$(MSBuildProjectName).nuspec')">$(MSBuildProjectName).nuspec</NuspecFile>
</PropertyGroup>

<Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" Condition=" '$(MicrosoftCommonPropsHasBeenImported)' != 'true' "/>
Expand All @@ -45,6 +45,7 @@
<Content Remove="Post-Deployment/**/*.sql" />
<Content Remove="bin/**/*.sql" />
<Content Remove="obj/**/*.sql" />
<None Include="$(OutputPath)\*.dacpac" Pack="true" PackagePath="tools/" />
</ItemGroup>

<PropertyGroup>
Expand Down
1 change: 0 additions & 1 deletion src/MSBuild.Sdk.SqlProj/Sdk/Sdk.targets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
tags=$(PackageTags);
configuration=$(Configuration);
tfm=$(TargetFramework);
packagetype=Dacpac
</NuspecProperties>
</PropertyGroup>
</Target>
Expand Down
20 changes: 0 additions & 20 deletions test/TestProject/TestProject.nuspec
View file

This file was deleted.

0 comments on commit 2baa8f8

Please sign in to comment.