Setup SSH

.github/workflows/release.yml

@@ -9,17 +9,23 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
+      # parse the release version from the github ref
       # https://stackoverflow.com/questions/58177786/get-the-current-pushed-tag-in-github-actions
       - name: Set env
         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
       - name: show release version
         run: echo ${{ env.RELEASE_VERSION }}
+
+      # setup build environment
       - uses: coursier/cache-action@v5
       - uses: olafurpg/setup-scala@v10
+
+      # enables signing for our packages
       - uses: crazy-max/ghaction-import-gpg@v3
         with:
           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
 
+      # this setup is all for the github pages deployment to work
       - name: install sphinx
         run: pip install --user sphinx sphinx_rtd_theme
 
@@ -28,12 +34,20 @@ jobs:
           git config user.name github-actions
           git config user.email github-actions@github.com
 
+      - name: Install SSH key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.SSH_KEY }}
+          known_hosts: ${{ secrets.KNOWN_HOSTS }}
+
+      # finally we can call the release stuff
       - name: sbt ci-release
         run: sbt ci-release
         env:
           BINTRAY_USER: ${{ secrets.BINTRAY_API_USER }}
           BINTRAY_PASS: ${{ secrets.BINTRAY_API_KEY }}
 
+      # TODO figure out how to minimize API requests. The cache doesn't seem to work
       # github_changelog_generator
       # - name: Generate changelog
       #   uses: heinrichreimer/github-changelog-generator-action@v2.1.1
@@ -56,6 +70,7 @@ jobs:
       #     signoff: true
       #   env:
       #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       # generate a github release
       - name: Generate release changelog
         id: changelog