automate github release with changelog (#626)

* automate github release with changelog

* apply PR feedback, add makefile, move scripts to _tooling

* fix docs index

Author: jstriebel

.github/workflows/ci.yml

@@ -417,7 +417,7 @@ jobs:
             "$SLACK_HOOK"
 
 
-  pypi:
+  pypi_and_gh_release:
     needs: [cluster_tools, webknossos_linux, wkcuber_linux, wkcuber_win, wkcuber_mac]
     if: |
       always() &&
@@ -443,10 +443,25 @@ jobs:
         env:
           PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
           PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: ./publish.sh
+        run: _tooling/publish.sh
+      - name: Prepare github release
+        run: |
+          VERSION="$(dunamai from git)"
+          _tooling/changelog_for_version.sh $VERSION > Changelog.md
+      - name: Publish github release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body_path: Changelog.md
+          draft: false
+          prerelease: false
 
   complete:
-    needs: [cluster_tools, webknossos_linux, wkcuber_linux, wkcuber_win, wkcuber_mac, wkcuber_docker, docs, pypi]
+    needs: [cluster_tools, webknossos_linux, wkcuber_linux, wkcuber_win, wkcuber_mac, wkcuber_docker, docs, pypi_and_gh_release]
     if: always()
     runs-on: ubuntu-latest
     steps:

.github/workflows/release.yml

@@ -37,7 +37,7 @@ jobs:
 
     - name: Make and push release
       run: |
-        ./make_release.sh ${VERSION}
+        _tooling/make_release.sh ${VERSION}
         git add */Changelog.md
 
         git commit -m "Release for v${VERSION}"

Makefile

@@ -0,0 +1,20 @@
+packages_by_priority := webknossos wkcuber cluster_tools docs
+packages_by_dependency := cluster_tools webknossos wkcuber docs
+
+define in_each_pkg_by_dependency
+  for PKG in $(packages_by_dependency); do echo $$PKG; cd $$PKG; $1; cd ..; done
+endef
+
+.PHONY: list_packages_by_priority update update-internal install
+
+list_packages_by_priority:
+	@echo $(packages_by_priority)
+
+update:
+	$(call in_each_pkg_by_dependency, poetry update --no-dev)
+
+update-internal:
+	$(call in_each_pkg_by_dependency, poetry update $(packages_by_dependency))
+
+install:
+	$(call in_each_pkg_by_dependency, poetry install)

make_changelog.py renamed to _tooling/changelog_bump_version.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+set -eEuo pipefail
+set +x
+
+if [ $# -eq 0 ]; then
+    VERSION_START="^## Unreleased"
+else
+    VERSION_START="^## \[$1\]"
+fi
+VERSION_END="^## \["
+
+for PKG in $(make list_packages_by_priority); do
+    if [ ! -f "$PKG/Changelog.md" ]; then
+        continue
+    fi
+
+    CHANGES="$(awk "/$VERSION_START/{flag=1;next} /$VERSION_END/{flag=0} flag" "$PKG/Changelog.md" | tail -n +2)"
+
+    WORDS_IN_CHANGES="$(echo "${CHANGES%x}" | grep --invert-match "###" | wc -w)"
+
+    if [ "$WORDS_IN_CHANGES" != "0" ]; then
+        echo "## $PKG"
+        echo "${CHANGES%x}"
+        echo
+        echo
+    fi
+done

_tooling/changelog_for_version.sh

@@ -9,7 +9,7 @@ fi
 
 PKG_VERSION="$1"
 
-if ! python check_version.py ${PKG_VERSION}; then
+if ! python _tooling/check_version.py ${PKG_VERSION}; then
     echo "A higher version is already present."
     exit 1
 fi
@@ -24,7 +24,7 @@ for PKG in */pyproject.toml; do
 
     pushd "$PKG" > /dev/null
 
-    python ../make_changelog.py "$PKG_VERSION"
+    python ../_tooling/changelog_bump_version.py "$PKG_VERSION"
 
     popd > /dev/null
 done

check_version.py renamed to _tooling/check_version.py

@@ -1,9 +1,11 @@
 [tool.poetry]
 name = "cluster_tools"
-version = "0.0.0"
+version = "0.0.0"  # filled by dunamai
 description = "Utility library for easily distributing code execution on clusters"
 authors = ["scalable minds <[email protected]>"]
+readme = "README.md"
 license = "MIT"
+repository = "https://github.com/scalableminds/webknossos-libs"
 
 [tool.poetry.dependencies]
 python = "^3.6.2"
@@ -22,4 +24,4 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.isort]
-profile = "black"
+profile = "black"

make_release.sh renamed to _tooling/make_release.sh

@@ -60,7 +60,7 @@ nav:
     - Frontend Scripting API: https://webknossos.org/assets/docs/frontend-api/index.html" target="_blank
     - Changelog: webknossos/CHANGELOG.released.md
     - Migration Guide: webknossos/MIGRATIONS.released.md
-    - [GitHub](https://github.com/scalableminds/webknossos)
+    - GitHub: https://github.com/scalableminds/webknossos" target="_blank
   - Getting Help:
     - webknossos/faq.md
     - Community Support: https://forum.image.sc/tag/webknossos" target="_blank