Merge pull request #7 from Crazy-Marvin/development

Release 0.3

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,54 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [development, master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [development]
+  schedule:
+    - cron: '0 22 * * 6'
+
+jobs:
+  analyse:
+    name: Analyse
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

README.md

@@ -9,8 +9,7 @@
 [![codecov](https://codecov.io/gh/Crazy-Marvin/2048TelegramBot/branch/master/graph/badge.svg)](https://codecov.io/gh/Crazy-Marvin/2048TelegramBot)
 [![Known Vulnerabilities](https://snyk.io/test/github/Crazy-Marvin/2048TelegramBot/badge.svg?targetFile=bot/requirements.txt)](https://snyk.io/test/github/Crazy-Marvin/2048TelegramBot?targetFile=bot/requirements.txt)
 [![Website](https://img.shields.io/website?url=https%3A%2F%2F2048.poopjournal.rocks%2F)](https://2048.poopjournal.rocks/)
-![healthchecks.io](https://img.shields.io/endpoint?url=https%3A%2F%2Fhealthchecks.io%2Fbadge%2F396c7d03-faf7-4562-9f83-1194d0%2FkXtEcp9g.shields)
-
+[![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fhealthchecks.io%2Fbadge%2F396c7d03-faf7-4562-9f83-1194d0%2FXr6YQGe8%2F2048.shields)](https://t.me/twothousandfortyeightbot?game=twothousandfortyeight)
 # 2048 on Telegram
 
 This [Telegram](https://telegram.org/) game/bot lets you play the 2048 game with your friends.

bot/README.md

@@ -73,6 +73,8 @@ Or on Windows
 
 For a persistent setup I would recommend a crontab or a systemd service.
 
+The server running the bot script needs to have a webserver (e.g. [Apache](https://httpd.apache.org/), [Caddy](https://caddyserver.com/) or [Nginx](https://www.nginx.com/)) with SSL (e.g. [Let's Encrypt](https://letsencrypt.org/)) running.
+
 # Monitoring
 
 You can monitor the bot using a service like [Healthchecks.io](https://healthchecks.io/) or [Cronitor](https://cronitor.io/) to get notified when the bot stops working.

bot/requirements.txt

@@ -1,2 +1,3 @@
 python-telegram-bot
 https://github.com/romangraef/configlib/archive/master.zip
+requests