Merge pull request #2988 from moreal/remove-libplanet-submodule

Remove libplanet submodule
planetarium · Nov 7, 2024 · 9b29c18 · 9b29c18
2 parents 020a494 + e51e19f
commit 9b29c18
Show file tree

Hide file tree

Showing 22 changed files with 130 additions and 130 deletions.
diff --git a/.Lib9c.Benchmarks/Lib9c.Benchmarks.csproj b/.Lib9c.Benchmarks/Lib9c.Benchmarks.csproj
@@ -15,14 +15,24 @@
       <PackageReference Include="BenchmarkDotNet" Version="0.12.1" />
     </ItemGroup>
 
+    <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+      <PackageReference Include="Libplanet" Version="$(LibplanetVersion)" />
+      <PackageReference Include="Libplanet.RocksDBStore" Version="$(LibplanetVersion)" />
+      <PackageReference Include="Libplanet.Crypto.Secp256k1" Version="$(LibplanetVersion)" />
+      <PackageReference Include="Libplanet.Mocks" Version="$(LibplanetVersion)" />
+    </ItemGroup>
+
+    <ItemGroup Condition="'$(UseLocalLibplanet)'">
+      <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet\Libplanet.csproj" />
+      <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet.RocksDBStore\Libplanet.RocksDBStore.csproj" />
+      <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet.Crypto.Secp256k1\Libplanet.Crypto.Secp256k1.csproj" />
+      <ProjectReference Include="$(LibplanetDirectory)\test\Libplanet.Mocks\Libplanet.Mocks.csproj" />
+    </ItemGroup>
+
     <ItemGroup>
       <ProjectReference Include="..\.Lib9c.Tests\Lib9c.Tests.csproj" />
-      <ProjectReference Include="..\.Libplanet\src\Libplanet.RocksDBStore\Libplanet.RocksDBStore.csproj" />
-      <ProjectReference Include="..\.Libplanet\src\Libplanet\Libplanet.csproj" />
       <ProjectReference Include="..\Lib9c\Lib9c.csproj" />
       <ProjectReference Include="..\Lib9c.Policy\Lib9c.Policy.csproj" />
-      <ProjectReference Include="..\Libplanet.Crypto.Secp256k1\Libplanet.Crypto.Secp256k1.csproj" />
-      <ProjectReference Include="..\.Libplanet\test\Libplanet.Mocks\Libplanet.Mocks.csproj" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/.Lib9c.Tests/Lib9c.Tests.csproj b/.Lib9c.Tests/Lib9c.Tests.csproj
@@ -50,7 +50,14 @@
     <ProjectReference Include="..\Lib9c\Lib9c.csproj" />
     <ProjectReference Include="..\Lib9c.Utils\Lib9c.Utils.csproj" />
     <ProjectReference Include="..\Lib9c.MessagePack\Lib9c.MessagePack.csproj" />
-    <ProjectReference Include="..\.Libplanet\test\Libplanet.Mocks\Libplanet.Mocks.csproj" />
+  </ItemGroup>
+
+  <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+    <PackageReference Include="Libplanet.Mocks" Version="$(LibplanetVersion)" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(UseLocalLibplanet)'">
+    <ProjectReference Include="$(LibplanetDirectory)\test\Libplanet.Mocks\Libplanet.Mocks.csproj" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(Configuration)' != 'DevEx' ">

diff --git a/.Lib9c.Tools/Lib9c.Tools.csproj b/.Lib9c.Tools/Lib9c.Tools.csproj
@@ -13,11 +13,18 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\.Libplanet\src\Libplanet.RocksDBStore\Libplanet.RocksDBStore.csproj" />
       <ProjectReference Include="..\Lib9c\Lib9c.csproj" />
       <ProjectReference Include="..\Lib9c.DevExtensions\Lib9c.DevExtensions.csproj" />
     </ItemGroup>
 
+    <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+      <PackageReference Include="Libplanet.RocksDBStore" Version="$(LibplanetVersion)" />
+    </ItemGroup>
+
+    <ItemGroup Condition="'$(UseLocalLibplanet)'">
+      <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet.RocksDBStore\Libplanet.RocksDBStore.csproj" />
+    </ItemGroup>
+
     <ItemGroup>
       <PackageReference Include="Cocona.Lite" Version="1.5.0" />
       <PackageReference Include="Serilog" Version="2.10.0" />

diff --git a/.Libplanet b/.Libplanet
diff --git a/...tionEvaluatorCommonComponents/Libplanet.Extensions.ActionEvaluatorCommonComponents.csproj b/...tionEvaluatorCommonComponents/Libplanet.Extensions.ActionEvaluatorCommonComponents.csproj
@@ -6,8 +6,12 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
-  <ItemGroup>
-    <ProjectReference Include="..\.Libplanet\src\Libplanet\Libplanet.csproj" />
+  <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+    <PackageReference Include="Libplanet" Version="$(LibplanetVersion)" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(UseLocalLibplanet)'">
+    <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet\Libplanet.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/.github/workflows/lib9c_plugin_build_and_push_s3.yaml b/.github/workflows/lib9c_plugin_build_and_push_s3.yaml
@@ -16,8 +16,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          submodules: true
       - uses: actions/setup-dotnet@v3
         with:
           dotnet-version: 6.0.400

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -9,3 +9,22 @@ jobs:
             - uses: actions/checkout@v4
             - name: Check typos
               uses: crate-ci/[email protected]
+
+    local-libplanet:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Check LibplanetDirectory is empty
+              run: grep -q '<LibplanetDirectory></LibplanetDirectory>' Directory.Build.props
+
+    no-submodules:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Check if there is submodule
+              run: |
+                set -ev
+                count=$(git submodule status | wc -l)
+                if [ "$count" -gt 0 ]; then
+                  exit 1
+                fi
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -20,8 +20,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-      with:
-        submodules: true
     - name: Check if .Libplanet refers to a tagged commit
       if: |
         github.event_name == 'push' && (
@@ -58,8 +56,6 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
-        with:
-          submodules: true
       - uses: actions/setup-dotnet@v3
         with:
           dotnet-version: 6.0.400
@@ -68,7 +64,6 @@ jobs:
           set -e
 
           sed -i -E 's|<TargetFramework>.*</TargetFramework>|<TargetFramework>netstandard2.1</TargetFramework>|' Lib9c*/*.csproj
-          sed -i -E 's|(<TargetFramework.+>).*(</TargetFramework>)|\1netstandard2.1\2|' .Libplanet/Directory.Build.props
           sed -i -E 's|<ImplicitUsings>.*</ImplicitUsings>|<ImplicitUsings>disable</ImplicitUsings>|' Lib9c*/*.csproj Libplanet*/*.csproj
           sed -i -E 's|\[MaybeNullWhen\(false\)] out TValue value|out TValue value|' Lib9c/TableData/Sheet.cs
           sed -i -E 's|public bool TryGetValue\(TKey key, out TValue value, bool throwException\)|public bool TryGetValue\(TKey key, out TValue? value, bool throwException\)|' Lib9c/TableData/Sheet.cs
@@ -79,8 +74,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          submodules: 'recursive'
       - name: Setup .NET Core
         uses: actions/setup-dotnet@v3
         with:
@@ -105,8 +98,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-      with:
-        submodules: true
     - name: Check if a new tag refers a merge commit
       if: github.ref_type == 'tag'
       run: |

diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -18,7 +18,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          submodules: recursive
           fetch-tags: true
       - name: Dotnet Setup
         uses: actions/setup-dotnet@v4

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -13,8 +13,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-      with:
-        submodules: true
     - uses: actions/setup-dotnet@v3
       with:
         dotnet-version: 6.0.400

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -11,10 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-      with:
-        submodules: true
-    - name: Git Sumbodule Update
-      run: git submodule update --init --recursive
     - uses: actions/setup-dotnet@v3
       with:
         dotnet-version: 6.0.x

diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +0,0 @@
-[submodule ".Libplanet"]
-	path = .Libplanet
-	url = https://github.com/planetarium/libplanet.git

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -111,3 +111,9 @@ This branch naming rule is not forced but highly recommended to recognize which
 - date (e.g., YYYYMMDD)
 - revision (e.g., some digits)
 - related base version (e.g., v200210)
+
+### Work with your local [Libplanet]
+
+If you want to work with your local [Libplanet], you can fill `LibplanetDirectory` property in `Directory.Build.props` file.
+
+When making a pull request, please do not include the `LibplanetDirectory` change.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -0,0 +1,18 @@
+<Project>
+    <PropertyGroup>
+        <LibplanetVersion>5.3.2-alpha.1</LibplanetVersion>
+
+        <!-- Fill with Libplanet's absolute path to debug with local Libplanet.
+             Example: $(MSBuildThisFileDirectory).Libplanet -->
+        <LibplanetDirectory></LibplanetDirectory>
+    </PropertyGroup>
+
+    <PropertyGroup>
+        <UseLocalLibplanet Condition="Exists('$(LibplanetDirectory)')">true</UseLocalLibplanet>
+        <UseLocalLibplanet Condition=" '$(UseLocalLibplanet)' == '' ">false</UseLocalLibplanet>
+    </PropertyGroup>
+
+    <Target Name="NoticeBuildingWithLocalLibplanet" BeforeTargets="BeforeBuild;BeforeRebuild">
+        <Message Importance="high" Text="Libplanet is being used as the local repository." Condition="$(UseLocalLibplanet)" />
+    </Target>
+</Project>
diff --git a/Lib9c.Abstractions/Lib9c.Abstractions.csproj b/Lib9c.Abstractions/Lib9c.Abstractions.csproj
@@ -9,8 +9,12 @@
     <VersionPrefix>1.19.0</VersionPrefix>
   </PropertyGroup>
 
-  <ItemGroup>
-    <ProjectReference Include="..\.Libplanet\src\Libplanet\Libplanet.csproj" />
+  <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+    <PackageReference Include="Libplanet" Version="$(LibplanetVersion)" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(UseLocalLibplanet)'">
+    <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet\Libplanet.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/Lib9c.DevExtensions/Lib9c.DevExtensions.csproj b/Lib9c.DevExtensions/Lib9c.DevExtensions.csproj
@@ -10,13 +10,22 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\.Libplanet\src\Libplanet.RocksDBStore\Libplanet.RocksDBStore.csproj" />
-    <ProjectReference Include="..\.Libplanet\src\Libplanet.Stun\Libplanet.Stun.csproj" />
-    <ProjectReference Include="..\.Libplanet\src\Libplanet\Libplanet.csproj" />
     <ProjectReference Include="..\Lib9c\Lib9c.csproj" />
     <ProjectReference Include="..\Lib9c.Policy\Lib9c.Policy.csproj" />
   </ItemGroup>
 
+  <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+    <PackageReference Include="Libplanet" Version="$(LibplanetVersion)" />
+    <PackageReference Include="Libplanet.Stun" Version="$(LibplanetVersion)" />
+    <PackageReference Include="Libplanet.RocksDBStore" Version="$(LibplanetVersion)" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(UseLocalLibplanet)'">
+    <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet\Libplanet.csproj" />
+    <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet.Stun\Libplanet.Stun.csproj" />
+    <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet.RocksDBStore\Libplanet.RocksDBStore.csproj" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Cocona.Core" Version="1.5.0" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />

diff --git a/Lib9c.Proposer/Lib9c.Proposer.csproj b/Lib9c.Proposer/Lib9c.Proposer.csproj
@@ -10,7 +10,13 @@
 
   <ItemGroup>
     <ProjectReference Include="..\Lib9c\Lib9c.csproj" />
-    <ProjectReference Include="..\.Libplanet\src\Libplanet.Net\Libplanet.Net.csproj" />
   </ItemGroup>
 
+  <ItemGroup Condition="!'$(UseLocalLibplanet)'">
+    <PackageReference Include="Libplanet.Net" Version="$(LibplanetVersion)" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(UseLocalLibplanet)'">
+    <ProjectReference Include="$(LibplanetDirectory)\src\Libplanet.Net\Libplanet.Net.csproj" />
+  </ItemGroup>
 </Project>