Merge pull request #8 from All-Of-Us-Mods/stylecop-and-new-build

Stylecop
All-Of-Us-Mods · Aug 29, 2024 · 869d497 · 869d497
2 parents 2cbbcca + eafc740
commit 869d497
Show file tree

Hide file tree

Showing 8 changed files with 327 additions and 53 deletions.
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -1,19 +1,28 @@
 name: CI
 
-on: workflow_dispatch
+on: ["workflow_dispatch", "push", "pull_request"]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: true
 
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.nuget/packages
+            ~/.cache/bepinex
+          key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-nuget-
+
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 6.x
+          dotnet-version: 8.0.x
 
       - name: Run the Cake script
         uses: cake-build/cake-action@v2
@@ -24,3 +33,19 @@ jobs:
         with:
           name: MiraAPI.dll
           path: MiraAPI/bin/Release/net6.0/MiraAPI.dll
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: AllOfUs.MiraAPI.nupkg
+          path: MiraAPI/bin/Release/AllOfUs.MiraAPI.*.nupkg
+
+      - uses: softprops/action-gh-release@v1
+        if: github.ref_type == 'tag'
+        with:
+          draft: true
+          files: MiraAPI/bin/Release/net6.0/MiraAPI.dll
+
+      - name: Push NuGet package
+        if: github.repository == 'All-Of-Us-Mods/MiraAPI' && github.ref == 'refs/heads/master' && github.ref_type == 'tag'
+        run: |
+          dotnet nuget push {MiraAPI/bin/Release/AllOfUs.MiraAPI.*.nupkg} --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@
 obj/
 bin/
 
-*.user
+*.user
+*.lock.json
diff --git a/AmongUs.props b/AmongUs.props
@@ -0,0 +1,14 @@
+<Project>
+    <ItemGroup>
+        <PackageReference Include="Reactor" Version="2.3.1" />
+        <PackageReference Include="BepInEx.Unity.IL2CPP" Version="6.0.0-be.697" Private="false" ExcludeAssets="runtime;native" />
+        <PackageReference Include="AmongUs.GameLibs.Steam" Version="2024.8.13" PrivateAssets="all" />
+
+        <PackageReference Include="BepInEx.AutoPlugin" Version="1.1.0" PrivateAssets="all" />
+        <PackageReference Include="BepInEx.IL2CPP.MSBuild" Version="2.0.1" PrivateAssets="all" ExcludeAssets="runtime" />
+    </ItemGroup>
+
+    <Target Name="Copy" AfterTargets="Build" Condition="'$(AmongUs)' != ''">
+        <Copy SourceFiles="$(TargetPath)" DestinationFolder="$(AmongUs)/BepInEx/plugins/" UseSymboliclinksIfPossible="true" />
+    </Target>
+</Project>
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -0,0 +1,40 @@
+<Project>
+    <PropertyGroup>
+        <TargetFramework>net6.0</TargetFramework>
+        <LangVersion>latest</LangVersion>
+        <DebugType>embedded</DebugType>
+        <Nullable>enable</Nullable>
+        <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+
+        <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+
+        <VersionPrefix>0.1.2</VersionPrefix>
+        <VersionSuffix>dev</VersionSuffix>
+
+        <Authors>All Of Us, XtraCube, Angxl</Authors>
+        <Company>All Of Us</Company>
+        <RepositoryType>git</RepositoryType>
+        <RepositoryUrl>https://github.com/All-Of-Us-Mods/MiraAPI</RepositoryUrl>
+        <PackageLicenseExpression>LGPL-2.1-or-later</PackageLicenseExpression>
+
+        <!-- SourceLink -->
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
+        <ContinuousIntegrationBuild Condition="'$(GITHUB_ACTIONS)' == 'true'">true</ContinuousIntegrationBuild>
+    </PropertyGroup>
+
+    <PropertyGroup>
+        <EnableNETAnalyzers>true</EnableNETAnalyzers>
+        <AnalysisLevel>latest</AnalysisLevel>
+        <AnalysisMode>recommended</AnalysisMode>
+        <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.556" PrivateAssets="all" />
+        <AdditionalFiles Include="$(MSBuildThisFileDirectory)\stylecop.json" Link="stylecop.json" Visible="false" />
+    </ItemGroup>
+    <PropertyGroup>
+        <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)\stylecop.ruleset</CodeAnalysisRuleSet>
+    </PropertyGroup>
+</Project>
diff --git a/MiraAPI.Example/MiraAPI.Example.csproj b/MiraAPI.Example/MiraAPI.Example.csproj
@@ -1,25 +1,9 @@
  <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFramework>net6.0</TargetFramework>
-		<LangVersion>latest</LangVersion>
-		<DebugType>embedded</DebugType>
-
-		<VersionPrefix>1.0.0</VersionPrefix>
-		<VersionSuffix>dev</VersionSuffix>
+		<Version>1.0.0</Version>
 		<Description>Example mod for Mira API</Description>
 		<Authors>Angxl, XtraCube</Authors>
 	</PropertyGroup>
-
-	<ItemGroup>
-		<PackageReference Include="Reactor" Version="2.3.1" />
-		<PackageReference Include="BepInEx.Unity.IL2CPP" Version="6.0.0-be.697" Private="false" ExcludeAssets="runtime;native" />
-		<PackageReference Include="AmongUs.GameLibs.Steam" Version="2024.8.13" PrivateAssets="all" />
-
-		<PackageReference Include="BepInEx.AutoPlugin" Version="1.1.0" PrivateAssets="all" />
-		<PackageReference Include="BepInEx.IL2CPP.MSBuild" Version="2.1.0-rc.1" PrivateAssets="all" ExcludeAssets="runtime">
-			<IncludeAssets>compile; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-		</PackageReference>
-	</ItemGroup>
 
 	<ItemGroup>
 		<ProjectReference Include="..\MiraAPI\MiraAPI.csproj" />
@@ -31,7 +15,5 @@
 		<EmbeddedResource Include="Resources\TeleportButton.png" />
 	</ItemGroup>
 
-	<Target Name="Copy" AfterTargets="Build" Condition="'$(AmongUs)' != ''">
-		<Copy SourceFiles="$(TargetPath)" DestinationFolder="$(AmongUs)/BepInEx/plugins/" UseSymboliclinksIfPossible="true" />
-	</Target>
+	<Import Project="..\AmongUs.props" />
 </Project>
diff --git a/MiraAPI/MiraAPI.csproj b/MiraAPI/MiraAPI.csproj
@@ -1,43 +1,20 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
-        <TargetFramework>net6.0</TargetFramework>
         <LangVersion>latest</LangVersion>
-        <DebugType>embedded</DebugType>
-        <PackageId>AllOfUs.MiraAPI</PackageId>
-        <Version>0.1.2</Version>
         <Description>Simple and easy to use Among Us modding API.</Description>
-        <Authors>Angxl, XtraCube</Authors>
-        <Company>All Of Us</Company>
-        <PackageLicenseExpression>LGPL-2.1-or-later</PackageLicenseExpression>
-        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageId>AllOfUs.MiraAPI</PackageId>
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
     </PropertyGroup>
 
     <ItemGroup>
         <None Include="..\README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <ItemGroup>
-        <EmbeddedResource Include="Resources\Checkmark.png" />
-        <EmbeddedResource Include="Resources\CheckMarkBox.png" />
-        <EmbeddedResource Include="Resources\Cog.png" />
-        <EmbeddedResource Include="Resources\CogActive.png" />
-        <EmbeddedResource Include="Resources\NextButton.png" />
-        <EmbeddedResource Include="Resources\NextButtonActive.png" />
-        <EmbeddedResource Include="Resources\Empty.png" />
-    </ItemGroup>
-
-    <ItemGroup>
-        <PackageReference Include="Reactor" Version="2.3.1" />
-        <PackageReference Include="BepInEx.Unity.IL2CPP" Version="6.0.0-be.697" Private="false" ExcludeAssets="runtime;native" />
-        <PackageReference Include="AmongUs.GameLibs.Steam" Version="2024.8.13" PrivateAssets="all" />
-
-        <PackageReference Include="BepInEx.AutoPlugin" Version="1.1.0" PrivateAssets="all" />
-        <PackageReference Include="BepInEx.IL2CPP.MSBuild" Version="2.1.0-rc.1" PrivateAssets="all" ExcludeAssets="runtime">
-            <IncludeAssets>compile; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-        </PackageReference>
+        <EmbeddedResource Include="Resources\**\*.*" />
     </ItemGroup>
 
-    <Target Name="Copy" AfterTargets="Build" Condition="'$(AmongUs)' != ''">
-        <Copy SourceFiles="$(TargetPath)" DestinationFolder="$(AmongUs)/BepInEx/plugins/" />
-    </Target>
+    <Import Project="../AmongUs.props" />   
+
 </Project>
diff --git a/stylecop.json b/stylecop.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
+  "settings": {
+    "orderingRules": {
+      "usingDirectivesPlacement": "outsideNamespace"
+    },
+    "layoutRules": {
+      "newlineAtEndOfFile": "require",
+      "allowDoWhileOnClosingBrace": true
+    },
+    "documentationRules": {
+      "xmlHeader": false,
+      "documentInterfaces": false
+    }
+  }
+}