feat: init commit

Author: ikesnowy

.github/workflows/main.yml

@@ -0,0 +1,24 @@
+name: Release Package
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  pack:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup NuGet.exe for use with actions
+        uses: NuGet/[email protected]
+        with:
+          nuget-api-key: ${{ secrets.NUGETAPIKEY }}
+
+      - name: Nuget Push
+        run: |
+          Version=${GITHUB_REF:10}
+          sed -i "s/\(<RuleSetVersion>\)[^<]*\(<\/RuleSetVersion>\)/\1$Version\2/" ./src/build/Cnblogs.CodeQuality.props
+          nuget pack ./src/Cnblogs.CodeQuality.nuspec -Version "$Version"
+          nuget push ./Cnblogs.CodeQuality.$Version.nupkg -NonInteractive -Source https://api.nuget.org/v3/index.json

README.md

@@ -1,2 +1,23 @@
-# code-quality
-A bunch of ruleset used by cnblogs
+# Cnblogs.CodeQuality
+A bunch of rulesets used by Cnblogs, including StyleCop (`SA-XXXX`) and some other rules (`CA-XXXX`, `IDE-XXXX`, `DOC-XXXX`).
+
+## How to use
+
+If you just want to apply style check in several projects, just install the `Cnblogs.CodeQuality` package on them.
+
+If you want to apply it solution wide, add the code below to your `Directory.Build.props` file.
+
+```xml
+<ItemGroup>
+  <PackageReference Include="Cnblogs.CodeQuality" Version="1.1.0">
+    <PrivateAssets>all</PrivateAssets>
+    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+  </PackageReference>
+</ItemGroup>
+```
+
+Rebuild you project/solution, `SA-XXXX` warnings or errors (if any) should appeared in your build output.
+
+If you are using Rider or Visual Studio, you may get quick fixes by enable the Roslyn analyzers in your IDE settings.
+
+**Rider Settings:** Editor -> Inspection Settings -> Roslyn Analyzers ([.NET Compiler Platform (Roslyn) Analyzers—JetBrains Rider](https://www.jetbrains.com/help/rider/Using_NET_Compiler_Analyzers.html))

src/Cnblogs.CodeQuality.nuspec

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
+  <metadata>
+    <id>Cnblogs.CodeQuality</id>
+    <title>Cnblogs.CodeQuality</title>
+    <version>$Version$</version>
+    <authors>Cnblogs</authors>
+    <owners>Cnblogs</owners>
+    <developmentDependency>true</developmentDependency>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <license type="expression">MIT</license>
+    <licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
+    <projectUrl>https://github.com/cnblogs/code-quality</projectUrl>
+    <releaseNotes>https://github.com/cnblogs/code-quality/releases</releaseNotes>
+    <description>Roslyn analyzer rulesets used by Cnblogs</description>
+    <dependencies>
+      <dependency id="StyleCop.Analyzers" version="[1.2.0-beta.312,1.3.0)" />
+    </dependencies>
+  </metadata>
+</package>