Create release.yamll (#116)

Author: btschwertfeger

.github/codecov.yml

@@ -18,6 +18,6 @@ coverage:
 comment:
   layout: "reach, diff, flags, files"
   behavior: default
-  require_changes: true # if false: post the comment even if coverage don't change
+  require_changes: true # if false: post the comment even if coverage doesn't change
   require_base: no # [yes :: must have a base report to post]
   require_head: yes # [yes :: must have a head report to post]

.github/release.yaml

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2023 Benjamin Thomas Schwertfeger
+# GitHub: https://github.com/btschwertfeger
+#
+# Based on https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+
+changelog:
+  exclude:
+    # labels:
+    #   - ignore-for-release
+    # authors:
+    #   - john-doe
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - breaking
+        - Breaking
+    - title: Implemented Enhancements 🎉
+      labels:
+        - Feature
+        - enhancement
+    - title: Fixed Bugs 🪲
+      labels:
+        - Bug
+        - bug
+    - title: Other Changes
+      labels:
+        - "*"
+      # exclude:
+      #   labels:
+      #     - dependencies
+    - title: 👒 Dependencies
+      labels:
+        - dependencies

README.md

@@ -35,6 +35,7 @@ Clients:
 
 - Spot REST Clients
 - Spot Websocket Client
+- Spot Orderbook Client
 - Futures REST Clients
 - Futures Websocket Client