Merge pull request #3843 from s2quake/chore/common-properties

MSBuild common properties
planetarium · Jul 4, 2024 · 1bed9c0 · 1bed9c0
2 parents 6ff3c4f + ad61add
commit 1bed9c0
Show file tree

Hide file tree

Showing 57 changed files with 524 additions and 1,484 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -112,36 +112,6 @@ commands:
         - "tools/*/bin/"
         - "tools/*/obj/"
 
-  mono_build_base:
-    steps:
-    - checkout
-    - concat_files:
-        glob: "{src,test,tools}/*/*.csproj"
-        to: .combined-package-files.txt
-    - restore_cache:
-        keys:
-        - v1-deps-{{ arch }}-{{ checksum ".combined-package-files.txt" }}
-        - v1-deps-{{ arch }}
-    - run: |
-        msbuild \
-          -t:Restore \
-          -p:Configuration=ReleaseMono \
-          -p:TestsTargetFramework=net47
-    - save_cache:
-        key: v1-deps-{{ arch }}-{{ checksum ".combined-package-files.txt" }}
-        paths:
-        - ~/.nuget/packages
-    - run: |
-        msbuild \
-          -p:Configuration=ReleaseMono \
-          -p:TestsTargetFramework=net47 \
-          -p:SkipSonar=true
-    - persist_to_workspace:
-        root: .
-        paths:
-        - "*/bin/"
-        - "*/obj/"
-
   netcore_test_base:
     parameters:
       collect_tests_from:
@@ -434,13 +404,6 @@ jobs:
     - netcore_build_base:
         collect_tests_filter: "<<parameters.collect_tests_filter>>"
 
-  linux-mono-build:
-    docker:
-    - image: mono:6.12
-    resource_class: xlarge
-    working_directory: /mnt/ramdisk
-    steps: [mono_build_base]
-
   linux-netcore-test-netmq:
     parameters:
       parallelism:
@@ -503,52 +466,11 @@ jobs:
     steps:
     - netcore_test_base: { code_coverage: false }
 
-  linux-unity-test:
-    docker:
-    - image: mono:6.12
-    environment:
-      XUNIT_UNITY_RUNNER: 0.5.0
-    resource_class: xlarge
-    working_directory: /mnt/ramdisk
-    parallelism: 4
-    steps:
-    - run:
-        name: Install xsltproc
-        command: apt update -y && apt install -y xsltproc
-    - unity_test_base
-
-  macos-unity-test:
-    macos:
-      xcode: 15.2.0
-    environment:
-      XUNIT_UNITY_RUNNER: 0.5.0
-    parallelism: 3
-    steps:
-    - ulimit: { n: 10240 }
-    - unity_test_base:
-        runner_target: StandaloneOSX
-
-  windows-unity-test:
-    executor:
-      name: win/default
-      size: xlarge
-    environment:
-      XUNIT_UNITY_RUNNER: 0.5.0
-    parallelism: 4
-    steps:
-    - run:
-        name: Install bzip2 & xsltproc
-        command: choco install bzip2 xsltproc
-    - unity_test_base:
-        runner_target: StandaloneWindows64
-
 workflows:
   main:
     jobs:
     - linux-netcore-build:
         collect_tests_filter: "FullyQualifiedName!~Libplanet.Net.Tests & CircleCI!=Skip"
-    # Temporarily tunred off by excluding of linux-unity-test
-    #- linux-mono-build
     - linux-netcore-test-netmq:
         requires: [linux-netcore-build]
     - linux-netcore-test-ar-SA:
@@ -559,15 +481,6 @@ workflows:
         requires: [linux-netcore-build]
     - windows-netcore-test:
         requires: [linux-netcore-build]
-    # Temporarily tunred off due to error on xunity-unity-runner:
-    #- linux-unity-test:
-    #    requires: [linux-mono-build]
-    # Temporarily turned off due to CircleCI's slow worker node assignments of
-    # macOS and Windows VMs:
-    #- macos-unity-test:
-    #    requires: [linux-mono-build]
-    #- windows-unity-test:
-    #    requires: [linux-mono-build]
   net:
     jobs:
     - linux-netcore-build:
@@ -577,10 +490,6 @@ workflows:
         name: linux-netcore-test-netmq-net
         requires: [linux-netcore-build-net]
         parallelism: 1
-    # - macos-netcore-test:
-    #     name: macos-netcore-test-net
-    #     requires: [linux-netcore-build-net]
-    #     parallelism: 1
     - windows-netcore-test:
         name: windows-netcore-test-net
         requires: [linux-netcore-build-net]

diff --git a/.github/bin/dist-pack.sh b/.github/bin/dist-pack.sh
@@ -59,9 +59,10 @@ for project in "${projects[@]}"; do
   if [[ "$version_suffix" = "" ]]; then
     dotnet_args="-p:Version=$version"
   else
-    dotnet_args="-p:VersionPrefix=$version_prefix" \
+    dotnet_args="-p:VersionPrefix=$version_prefix"
     dotnet_args="$dotnet_args --version-suffix=$version_suffix"
     dotnet_args="$dotnet_args -p:NoPackageAnalysis=true"
+    dotnet_args="$dotnet_args -p:_IsPacking=true"
   fi
   # shellcheck disable=SC2086
   dotnet build -c "$configuration" $dotnet_args || \

diff --git a/CHANGES.md b/CHANGES.md
@@ -27,6 +27,66 @@ To be released.
 
 ### Dependencies
 
+The entire project is now defined by common properties in the
+`Directory.Build.props` file. The Directory.Build.props file is located at
+the root and in the src, tools, test path.
+
+The project structure and affected Directory.Build.props locations are shown
+below.
+
+```plain
+┌ Directory.Build.props
+├ src
+│  ├ Directory.Build.props
+│  ├ Libplanet
+│  ├ Libplanet.Action
+│  ├ Libplanet.Common
+│  ├ Libplanet.Crypto.Secp256k1
+│  ├ Libplanet.Crypto
+│  ├ Libplanet.Net
+│  ├ Libplanet.RocksDBStore
+│  ├ Libplanet.Store.Remote
+│  ├ Libplanet.Store
+│  ├ Libplanet.Stun
+│  └ Libplanet.Types
+├ test
+│  ├ Directory.Build.props
+│  ├ Libplanet.Action.Tests
+│  ├ Libplanet.Analyzers.Tests
+│  ├ Libplanet.Crypto.Secp256k1.Tests
+│  ├ Libplanet.Explorer.Cocona.Tests
+│  ├ Libplanet.Explorer.Tests
+│  ├ Libplanet.Extensions.Cocona.Tests
+│  ├ Libplanet.Mocks
+│  ├ Libplanet.Net.Tests
+│  ├ Libplanet.RocksDBStore.Tests
+│  ├ Libplanet.Store.Remote.Tests
+│  ├ Libplanet.Stun.Tests
+│  └ Libplanet.Tests
+└ tools
+   ├ Directory.Build.props
+   ├ Libplanet.Analyzers
+   ├ Libplanet.Benchmarks
+   ├ Libplanet.Explorer.Cocona
+   ├ Libplanet.Explorer.Executable
+   ├ Libplanet.Explorer
+   ├ Libplanet.Extensions.Cocona
+   └ Libplanet.Tools
+```
+
+The default SDK version for the project has been bumped up to .NET 6.0.
+The list of supported SDKs is as follows
+ - netstandard2.0
+ - netstandard2.1
+ - netcoreapp3.1
+ - net6.0"
+
+> Support for `netstandard2.0` is coming to an end soon, please note that
+projects using `netstandard2.0` will be deprecated.
+
+The `VersionPrefix` property has been moved from the
+*src/Libplanet/Libplanet.csproj* file to the `Directory.Build.props` file.
+
 ### CLI tools
 
 [#3737]: https://github.com/planetarium/libplanet/pull/3737

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -0,0 +1,76 @@
+<Project>
+
+  <PropertyGroup>
+    <TargetFrameworks Condition="'$(_IsPacking)'=='true'">net6.0</TargetFrameworks>
+    <TargetFramework Condition="'$(_IsPacking)'!='true'">net6.0</TargetFramework>
+    <LangVersion>10</LangVersion>
+    <VersionPrefix>5.1.0</VersionPrefix>
+    <!-- Note: don't be confused by the word "prefix" here.  It's merely a
+    version without suffix like "-dev.123".  See the following examples:
+    Version: 1.2.3-dev.456
+    VersionPrefix: 1.2.3
+    VersionSuffix: dev.456
+    If it's a stable release the version becomes like:
+    Version: 1.2.3
+    VersionPrefix: 1.2.3
+    VersionSuffix: (N/A)
+    Note that the version suffix is filled through CLI option of dotnet command.
+    -->
+    <Nullable>enable</Nullable>
+    <PackageProjectUrl>https://libplanet.io/</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/planetarium/libplanet.git</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <Company>Planetarium</Company>
+    <Authors>Planetarium</Authors>
+    <PackageLicenseExpression>LGPL-2.1-or-later</PackageLicenseExpression>
+    <RequireLicenseAcceptance>true</RequireLicenseAcceptance>
+    <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)Libplanet.ruleset</CodeAnalysisRuleSet>
+    <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow>
+
+    <PackageReleaseNotes>https://github.com/planetarium/libplanet/blob/main/CHANGES.md</PackageReleaseNotes>
+    <PackageTags>multiplayer online game;game;blockchain</PackageTags>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageIcon>icon.png</PackageIcon>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="$(MSBuildThisFileDirectory)CHANGES.md" Pack="true" PackagePath="CHANGES.md" />
+    <None Include="$(MSBuildThisFileDirectory)LICENSE" Pack="true" PackagePath="LICENSE.txt" />
+    <None Include="$(MSBuildThisFileDirectory)README.md" Pack="true" PackagePath="README.md" />
+    <None Include="$(MSBuildThisFileDirectory)icon.png" Pack="true" PackagePath="icon.png" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)Menees.Analyzers.Settings.xml">
+      <Link>Menees.Analyzers.Settings.xml</Link>
+    </AdditionalFiles>
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" />
+  </ItemGroup>
+
+  <ItemGroup>
+     <PackageReference Include="Menees.Analyzers.2017" Version="2.0.3">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.DotNet.Analyzers.Compatibility" Version="0.2.12-alpha">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>
+        runtime; build; native; contentfiles; analyzers; buildtransitive
+      </IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.164">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>
+        runtime; build; native; contentfiles; analyzers
+      </IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(SkipSonar)' != 'true'">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.12.0.21095">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+</Project>
diff --git a/Libplanet.Tests.ruleset b/Libplanet.Tests.ruleset
@@ -51,6 +51,7 @@
     <Rule Id="MEN009" Action="Warning" />
     <Rule Id="MEN010" Action="None" />
     <Rule Id="MEN011" Action="None" />
+    <Rule Id="MEN014" Action="None" />
   </Rules>
 
   <Rules AnalyzerId="SonarAnalyzer" RuleNamespace="SonarAnalyzer">

diff --git a/Libplanet.ruleset b/Libplanet.ruleset
@@ -43,6 +43,7 @@
     <Rule Id="MEN009" Action="Warning" />
     <Rule Id="MEN010" Action="None" />
     <Rule Id="MEN011" Action="None" />
+    <Rule Id="MEN014" Action="None" />
   </Rules>
 
   <Rules AnalyzerId="SonarAnalyzer" RuleNamespace="SonarAnalyzer">

diff --git a/RELEASE.md b/RELEASE.md
@@ -186,7 +186,7 @@ You also need to prepare the next patch release.  Switch to the maintenance
 branch (e.g., *1.2-maintenance*), and make sure it is up-to-date.
 
 You need to bump the patch version of the `<VersionPrefix>` field
-in the *src/Libplanet/Libplanet.csproj* file.  For example, if the version you have
+in the *Directory.Build.props* file.  For example, if the version you have
 just released is *1.2.3*, bump it to *1.2.4* (3 + 1 = 4).
 
 Also the changelog section for the next patch release should be prepared; add
@@ -236,7 +236,7 @@ git reset --hard upstream/main
 ~~~~
 
 Since this maintenance branch purposes to prepare the next patch release, e.g.,
-*1.2.1*, the `<VersionPrefix>` field of the *src/Libplanet/Libplanet.csproj*
+*1.2.1*, the `<VersionPrefix>` field of the *Directory.Build.props*
 file also needs to be updated:
 
 ~~~~ xml
@@ -279,7 +279,7 @@ git switch main  # Or on Git < 2.23: git checkout main
 git fetch upstream && git reset --hard upstream/main
 ~~~~
 
-Then, in a similar manner, update *src/Libplanet/Libplanet.csproj*'s
+Then, in a similar manner, update *Directory.Build.props*'s
 `<VersionPrefix>` to *1.3.0*, and add an empty section for *1.3.0* with
 the release date undecided to the changelog.  Make a commit with a simple
 message like <q>Version bump</q>.
@@ -332,7 +332,7 @@ The checklist to prepare the next release:
      5. Switch to the *<var>X</var>.<var>Y</var>-maintenance* branch and
         make sure it is up-to-date.
      6. Bump `<VersionPrefix>`'s patch version on
-        *src/Libplanet/Libplanet.csproj*.
+        *Directory.Build.props*.
         (For example, if you have just released *1.2.3*, bump it to *1.2.4*.)
      7. Add a new section for the next unreleased version to the changelog,
         with the sentence <q>To be released</q> (no release date).
@@ -344,15 +344,15 @@ The checklist to prepare the next release:
 
      1. Create a new branch named *<var>X</var>.<var>Y</var>-maintenance* and
         switch to it.
-     2. Bump `<VersionPrefix>` on *src/Libplanet/Libplanet.csproj* to
+     2. Bump `<VersionPrefix>` on *Directory.Build.props* to
         *<var>X</var>.<var>Y</var>.1*.
      3. Add a new section for the next unreleased version
         (*<var>X</var>.<var>Y</var>.1*) to the changelog, with the sentence
         <q>To be released</q> (no release date).
      4. Commit the changes with a message <q>Version bump</q>.
      5. `git push upstream X.Y-maintenance`
      6. Switch to the *main* branch.
-     7. Bump `<VersionPrefix>`'s minor version on *src/Libplanet/Libplanet.csproj*.
+     7. Bump `<VersionPrefix>`'s minor version on *Directory.Build.props*.
         (For example, if you have just released *1.2.0*, bump it to *1.3.0*.)
      8. Add a new section for the next unreleased minor version to the
         changelog, with the sentence <q>To be released</q> (no release date).

diff --git a/scripts/determine-version.js b/scripts/determine-version.js
@@ -76,9 +76,7 @@ function getScheduledJobDate() {
 async function main() {
   const csprojPath = path.join(
     path.dirname(__dirname),
-    "src",
-    "Libplanet",
-    "Libplanet.csproj",
+    "Directory.Build.props",
   );
   const versionPrefix = await readVersionPrefix(csprojPath);
   const scheduledJobDate = getScheduledJobDate();

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -0,0 +1,13 @@
+<Project>
+
+  <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />
+
+  <PropertyGroup>
+    <TargetFrameworks Condition="'$(_IsPacking)'=='true'">$(TargetFrameworks);netstandard2.0;netstandard2.1;netcoreapp3.1</TargetFrameworks>
+    <LangVersion>9</LangVersion>
+    <IsPackable>true</IsPackable>
+    <IsTestProject>false</IsTestProject>
+    <Title>$(ProjectName)</Title>
+  </PropertyGroup>
+
+</Project>