ci: release on demand (#1293)

Closes #1273.

### Summary of Changes

* Don't release when pushing to `main` anymore
* Instead release on demand
* Update a changelog on release and push the updated changelog to `main`

Author: lars-reimann

.github/dependabot.yml

@@ -5,19 +5,28 @@
 
 version: 2
 updates:
+  # root
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:
       interval: 'monthly'
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+
+  # api-editor
   - package-ecosystem: 'gradle'
     directory: '/api-editor'
     schedule:
       interval: 'monthly'
   - package-ecosystem: 'npm'
-    directory: '/'
+    directory: '/api-editor/gui'
     schedule:
       interval: 'monthly'
-  - package-ecosystem: 'npm'
-    directory: '/api-editor/gui'
+
+  # docs
+  - package-ecosystem: 'pip'
+    directory: '/docs'
     schedule:
       interval: 'monthly'

.github/workflows/main.yml

@@ -59,14 +59,6 @@ jobs:
           directory: api-editor/build/reports/kover/merged/xml
           files: report.xml
 
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Release
-        run: npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
   gui-test-coverage:
     runs-on: ubuntu-latest
     defaults:

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release to GitHub
+
+on:
+  workflow_dispatch
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [ 18.x ]
+        java-version: [ 17 ]
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+          cache-dependency-path: api-editor/gui/package-lock.json
+
+      - name: Set up JDK ${{ matrix.java-version }}
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: ${{ matrix.java-version }}
+          cache: gradle
+
+      # See https://docs.github.com/en/actions/guides/building-and-testing-java-with-gradle
+      - name: Setup Gradle
+        uses: gradle/wrapper-validation-action@v1
+
+      - name: Build with Gradle
+        run: ./gradlew build
+        working-directory: ./api-editor
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT }}

docs/CHANGELOG.md

@@ -1,3 +1,4 @@
 mkdocs==1.4.2
 mkdocs-glightbox==0.3.1
 mkdocs-material==9.1.0
+mkdocs-section-index==0.3.5

docs/requirements.txt

@@ -3,7 +3,9 @@ repo_url: https://github.com/Safe-DS/API-Editor
 repo_name: Safe-DS/API-Editor
 
 nav:
-  - Home: README.md
+  - Home:
+    - README.md
+    - Changelog: CHANGELOG.md
   - GUI: gui.md
 
 # Configuration of MkDocs & Material for MkDocs --------------------------------