Docker

OoLunar · OoLunar · commit 0e5e0bf49620 · 2022-05-17T15:53:57.000-05:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,6 @@
+.github
+.vscode
+.gitignore
+.editorconfig
+bin
+obj
diff --git a/.github/workflows/docker_image.yml b/.github/workflows/docker_image.yml
@@ -0,0 +1,39 @@
+name: Publish Docker image
+on:
+  release:
+    types: [published]
+
+jobs:
+  push_to_registry:
+    name: Publish Docker image
+    runs-on: self-hosted
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v2
+
+      - name: Get Previous tag
+        id: previoustag
+        uses: WyriHaximus/github-action-get-previous-tag@master
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and Push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ghcr.io/dsharpplus/dsharpplusdocs:latest
+            ghcr.io/dsharpplus/dsharpplusdocs:${{ steps.previoustag.outputs.tag }}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,24 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceFolder}/bin/Debug/net6.0/DSharpPlusDocs.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}",
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach"
+        }
+    ]
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,41 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/DSharpPlusDocs.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/DSharpPlusDocs.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "--project",
+                "${workspaceFolder}/DSharpPlusDocs.csproj"
+            ],
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,14 @@
+FROM mcr.microsoft.com/dotnet/sdk:6.0-alpine AS build
+WORKDIR /src
+
+COPY ./ /src
+RUN dotnet restore -r linux-musl-x64 && dotnet publish -c Release -r linux-musl-x64 --no-restore --self-contained -p:PublishSingleFile=true -p:EnableCompressionInSingleFile=true -p:DebugType=embedded
+
+FROM alpine:latest
+WORKDIR /src
+
+COPY --from=build /src/bin/Release/net6.0/linux-musl-x64/publish /src
+COPY ./res /src/res
+RUN apk upgrade --update-cache --available && apk add openssl libstdc++ icu-libs && rm -rf /var/cache/apk/*
+
+ENTRYPOINT /src/DSharpPlusDocs
diff --git a/Modules/Commands.cs b/Modules/Commands.cs
@@ -41,13 +41,15 @@
 using Microsoft.CodeAnalysis.Scripting;
 using Microsoft.Extensions.DependencyInjection;
 
+#pragma warning disable CA1822 // Mark members as static
+
 namespace DSharpPlusDocs.Modules
 {
     public class GeneralCommands : BaseCommandModule
     {
         [Command("clean")]
         [Description("Delete all the messages from this bot within the last X messages")]
-        public static async Task CleanAsync(CommandContext ctx, int messages = 30)
+        public async Task CleanAsync(CommandContext ctx, int messages = 30)
         {
             if (messages > 50)
             {
@@ -68,16 +70,16 @@ public static async Task CleanAsync(CommandContext ctx, int messages = 30)
 
         [Command("docs")]
         [Description("Show the docs url")]
-        public static async Task DocsAsync(CommandContext ctx) => await ctx.RespondAsync($"Docs: {QueryHandler.DocsBaseUrl}");
+        public async Task DocsAsync(CommandContext ctx) => await ctx.RespondAsync($"Docs: {QueryHandler.DocsBaseUrl}");
 
         [Command("invite")]
         [Description("Show the invite url")]
-        public static async Task InviteAsync(CommandContext ctx) => await ctx.RespondAsync("Invite: https://discordapp.com/oauth2/authorize?client_id=341606460720939008&scope=bot");
+        public async Task InviteAsync(CommandContext ctx) => await ctx.RespondAsync("Invite: https://discordapp.com/oauth2/authorize?client_id=341606460720939008&scope=bot");
 
         [Command("guides")]
         [Aliases("guide")]
         [Description("Show the url of a guide")]
-        public static async Task GuidesAsync(CommandContext ctx, [RemainingText] string guide = null)
+        public async Task GuidesAsync(CommandContext ctx, [RemainingText] string guide = null)
         {
             try
             {
@@ -202,7 +204,7 @@ public static async Task GuidesAsync(CommandContext ctx, [RemainingText] string
 
         [Command("info")]
         [Description("Show some information about the application")]
-        public static async Task InfoAsync(CommandContext ctx)
+        public async Task InfoAsync(CommandContext ctx)
         {
             _ = ctx.Client.CurrentApplication;
             MainHandler mainHandler = ctx.Services.GetService<MainHandler>();
@@ -244,7 +246,7 @@ public static async Task InfoAsync(CommandContext ctx)
 
         [Command("eval")] //TODO: Safe eval ? 👀
         [RequireOwner]
-        public static async Task EvalAsync(CommandContext ctx, [RemainingText] string code)
+        public async Task EvalAsync(CommandContext ctx, [RemainingText] string code)
         {
             /*using (Context.Channel.EnterTypingState())
             {*/
@@ -278,7 +280,7 @@ public static async Task EvalAsync(CommandContext ctx, [RemainingText] string co
 
         [Command("setdocsurl")]
         [RequireOwner]
-        public static async Task SetDocsUrlAsync(CommandContext ctx, [RemainingText] string url)
+        public async Task SetDocsUrlAsync(CommandContext ctx, [RemainingText] string url)
         {
             if (!url.EndsWith("/"))
             {
diff --git a/Program.cs b/Program.cs
@@ -25,9 +25,6 @@ namespace DSharpPlusDocs
 {
     public class Program
     {
-        public static void Main()
-        {
-            new DSharpPlusDocs().RunAsync().GetAwaiter().GetResult();
-        }
+        public static void Main() => new DSharpPlusDocs().RunAsync().GetAwaiter().GetResult();
     }
 }
diff --git a/Query/Extensions/BaseDisplay.cs b/Query/Extensions/BaseDisplay.cs
@@ -130,7 +130,8 @@ private static string GetDocsUrlPath(object o)
 
         public static bool IsInherited(object o) => o is PropertyInfoWrapper property
                 ? $"{property.Parent.TypeInfo.Namespace}.{property.Parent.TypeInfo.Name}" != $"{property.Property.DeclaringType.Namespace}.{property.Property.DeclaringType.Name}"
-                : o is MethodInfoWrapper method && $"{method.Parent.TypeInfo.Namespace}.{method.Parent.TypeInfo.Name}" != $"{method.Method.DeclaringType.Namespace}.{method.Method.DeclaringType.Name}";
+                : o is MethodInfoWrapper method
+                && $"{method.Parent.TypeInfo.Namespace}.{method.Parent.TypeInfo.Name}" != $"{method.Method.DeclaringType.Namespace}.{method.Method.DeclaringType.Name}";
 
         private static List<string> GetPaths(IEnumerable<object> list) => list.Select(x => GetPath(x)).ToList();
 
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# DSharpPlus Documentation Bot
+Don't host this until the rewrite. PR's to make the code more optimized are welcome.
+
+# Getting Started
+Set the `DISCORD_TOKEN` environment variable to your bot's token, then `dotnet run`. Alternatively you can use Docker.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,8 @@
+version: "3.9"
+
+services:
+  tomoe:
+    build: .
+    environment:
+      - "DISCORD_TOKEN": ""
+    restart: unless-stopped

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +.github
 +.vscode
 +.gitignore
 +.editorconfig
 +bin
 +obj
Original file line number	Diff line number	Diff line change
`@@ -41,13 +41,15 @@`
`41`	`41`	`using Microsoft.CodeAnalysis.Scripting;`
`42`	`42`	`using Microsoft.Extensions.DependencyInjection;`
`43`	`43`
	`44`	`+#pragma warning disable CA1822 // Mark members as static`
	`45`	`+`
`44`	`46`	`namespace DSharpPlusDocs.Modules`
`45`	`47`	`{`
`46`	`48`	`public class GeneralCommands : BaseCommandModule`
`47`	`49`	`{`
`48`	`50`	`[Command("clean")]`
`49`	`51`	`[Description("Delete all the messages from this bot within the last X messages")]`
`50`		`- public static async Task CleanAsync(CommandContext ctx, int messages = 30)`
	`52`	`+ public async Task CleanAsync(CommandContext ctx, int messages = 30)`
`51`	`53`	`{`
`52`	`54`	`if (messages > 50)`
`53`	`55`	`{`
`@@ -68,16 +70,16 @@ public static async Task CleanAsync(CommandContext ctx, int messages = 30)`
`68`	`70`
`69`	`71`	`[Command("docs")]`
`70`	`72`	`[Description("Show the docs url")]`
`71`		`- public static async Task DocsAsync(CommandContext ctx) => await ctx.RespondAsync($"Docs: {QueryHandler.DocsBaseUrl}");`
	`73`	`+ public async Task DocsAsync(CommandContext ctx) => await ctx.RespondAsync($"Docs: {QueryHandler.DocsBaseUrl}");`
`72`	`74`
`73`	`75`	`[Command("invite")]`
`74`	`76`	`[Description("Show the invite url")]`
`75`		`- public static async Task InviteAsync(CommandContext ctx) => await ctx.RespondAsync("Invite: https://discordapp.com/oauth2/authorize?client_id=341606460720939008&scope=bot");`
	`77`	`+ public async Task InviteAsync(CommandContext ctx) => await ctx.RespondAsync("Invite: https://discordapp.com/oauth2/authorize?client_id=341606460720939008&scope=bot");`
`76`	`78`
`77`	`79`	`[Command("guides")]`
`78`	`80`	`[Aliases("guide")]`
`79`	`81`	`[Description("Show the url of a guide")]`
`80`		`- public static async Task GuidesAsync(CommandContext ctx, [RemainingText] string guide = null)`
	`82`	`+ public async Task GuidesAsync(CommandContext ctx, [RemainingText] string guide = null)`
`81`	`83`	`{`
`82`	`84`	`try`
`83`	`85`	`{`
`@@ -202,7 +204,7 @@ public static async Task GuidesAsync(CommandContext ctx, [RemainingText] string`
`202`	`204`
`203`	`205`	`[Command("info")]`
`204`	`206`	`[Description("Show some information about the application")]`
`205`		`- public static async Task InfoAsync(CommandContext ctx)`
	`207`	`+ public async Task InfoAsync(CommandContext ctx)`
`206`	`208`	`{`
`207`	`209`	`_ = ctx.Client.CurrentApplication;`
`208`	`210`	`MainHandler mainHandler = ctx.Services.GetService<MainHandler>();`
`@@ -244,7 +246,7 @@ public static async Task InfoAsync(CommandContext ctx)`
`244`	`246`
`245`	`247`	`[Command("eval")] //TODO: Safe eval ? 👀`
`246`	`248`	`[RequireOwner]`
`247`		`- public static async Task EvalAsync(CommandContext ctx, [RemainingText] string code)`
	`249`	`+ public async Task EvalAsync(CommandContext ctx, [RemainingText] string code)`
`248`	`250`	`{`
`249`	`251`	`/*using (Context.Channel.EnterTypingState())`
`250`	`252`	`{*/`
`@@ -278,7 +280,7 @@ public static async Task EvalAsync(CommandContext ctx, [RemainingText] string co`
`278`	`280`
`279`	`281`	`[Command("setdocsurl")]`
`280`	`282`	`[RequireOwner]`
`281`		`- public static async Task SetDocsUrlAsync(CommandContext ctx, [RemainingText] string url)`
	`283`	`+ public async Task SetDocsUrlAsync(CommandContext ctx, [RemainingText] string url)`
`282`	`284`	`{`
`283`	`285`	`if (!url.EndsWith("/"))`
`284`	`286`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,6 @@ namespace DSharpPlusDocs`
`25`	`25`	`{`
`26`	`26`	`public class Program`
`27`	`27`	`{`
`28`		`- public static void Main()`
`29`		`- {`
`30`		`- new DSharpPlusDocs().RunAsync().GetAwaiter().GetResult();`
`31`		`- }`
	`28`	`+ public static void Main() => new DSharpPlusDocs().RunAsync().GetAwaiter().GetResult();`
`32`	`29`	`}`
`33`	`30`	`}`