Add changelog and use auto for creating releases (#156)

Changes made:
* add initial configuration
* generate the changelog and format it
* modify the cd pipeline to only append the generated build files
* update the contribution documentation to reflect changes in the release process

.autorc

@@ -0,0 +1,29 @@
+{
+  "plugins": [
+    "first-time-contributor",
+    [
+      "omit-release-notes",
+      {
+        "labels": "ignore-release"
+      }
+    ]
+  ],
+  "owner": "builditluc",
+  "repo": "wiki-tui",
+  "baseBranch": "main",
+
+  "noDefaultLabels": true,
+  "labels": [
+    { "name": "breaking-change", "description": "This introduces a breaking change to the codebase. Increment the major version", "changelogTitle": "Breaking Changes 🛠", "releaseType": "major", "color": "#b60205" },
+    { "name": "type: bug", "description": "This fixes a bug. Increment the minor version", "changelogTitle": "Bug Fixes 🐛", "releaseType": "patch", "color": "#b60205" },
+    { "name": "type: chore", "description": "Updates to the build process or dependency updates", "changelogTitle": "CI Pipeline and Dependency Updates", "releaseType": "none", "color": "#fef2c0" },
+    { "name": "type: documentation", "description": "Changes to the documentation (in code and external documentation)", "changelogTitle": "Documentation Changes", "releaseType": "none", "color": "#1d76db" },
+    { "name": "type: feature", "description": "Implements a new feature", "changelogTitle": "Exciting New Features 🎉", "releaseType": "minor", "color": "#a2eeef" },
+    { "name": "type: refactor", "description": "Changes to the style and structure of the codebase or project", "changelogTitle": "Structure and Style Changes", "releaseType": "none", "color": "#bfdadc" },
+    { "name": "type: testing", "description": "Changes to the tests", "changelogTitle": "Tests", "releaseType": "none", "color": "#f9d0c4" },
+    { "name": "ignore-release", "description": "This won't be included in the release notes", "releaseType": "skip", "color": "#5ceb33" },
+    { "name": "other", "releaseType": "none", "default": true, "changelogTitle": "Other Changes" }
+  ],
+
+  "changelog": { "message": "Update Changelog" }
+}

.github/workflows/cd.yml

@@ -71,20 +71,6 @@ jobs:
             target/${{ matrix.target }}/release/wiki-tui-${{ matrix.artifact_prefix }}.tar.gz
             target/${{ matrix.target }}/release/wiki-tui-${{ matrix.artifact_prefix }}.sha256
             LICENSE.txt
-          generate_release_notes: true
+          generate_release_notes: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  publish:
-    name: Publish to crates.io
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: publish
-          args: --token ${{ secrets.CRATES_TOKEN }}

.gitignore

@@ -10,4 +10,5 @@ wiki_tui.log
 
 .direnv/cache-pre321137.8e1eab9eae4
 .direnv/drv
-.direnv
+.direnv
+.env