#45: Add release-droid GitHub workflow and prepare for release

.github/workflows/check_version.yaml

@@ -0,0 +1,23 @@
+name: Check if versions are consistent
+
+on: pull_request
+
+jobs:
+  check-version-numbers:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Python 3.6
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: 1.1.6
+
+      - name: Check Release
+        run: ./scripts/build/check_release.sh

.github/workflows/release_droid_upload_github_release_assets.yml

@@ -0,0 +1,86 @@
+name: Release Droid - Upload GitHub Release Assets
+
+on:
+  workflow_dispatch:
+    inputs:
+      upload_url:
+        description: 'Upload URL'
+        required: true
+
+jobs:
+  check-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python 3.6 for integration-test-docker-environment
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: 1.1.6
+
+      - name: Check Release
+        run: ./scripts/build/check_release.sh
+
+  integration_tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: 1.1.4
+      - name: Poetry install
+        run: poetry install
+      - name: Poetry build
+        run: poetry build
+
+      - name: Checkout test environment
+        run: git clone https://github.com/exasol/integration-test-docker-environment.git
+        working-directory: ..
+      - name: Spawn EXASOL environemnt
+        run: ./start-test-env spawn-test-environment --environment-name test --database-port-forward 8888 --bucketfs-port-forward 6666 --db-mem-size 4GB
+        working-directory: ../integration-test-docker-environment
+
+      - name: Poetry run pytest integration tests
+        run: poetry run pytest tests
+
+  upload:
+    needs: [integration_tests, check-release]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Python 3.6
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.6
+
+    - name: Install Poetry
+      uses: abatilo/actions-poetry@v2.0.0
+      with:
+        poetry-version: 1.1.6
+
+    - name: Build Release
+      run: |
+        bash ./scripts/build/build_release.sh
+
+    - name: Upload assets to the GitHub release draft
+      uses: shogo82148/actions-upload-release-asset@v1
+      with:
+        upload_url: ${{ github.event.inputs.upload_url }}
+        asset_path: dist/*
+

.github/workflows/shellcheck.yaml

@@ -0,0 +1,11 @@
+name: Check bash scripts
+
+on: [push, pull_request]
+
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run shellcheck
+        run: ./scripts/build/shellcheck.sh

.gitignore

@@ -136,3 +136,4 @@ poetry.lock
 
 # Sphinx
 doc/_build
+doc/api

doc/changes/changelog.md

@@ -0,0 +1,3 @@
+# Changes
+
+* [0.1.0](changes_0.1.0.md)

doc/changes/changes_0.1.0.md

@@ -1,3 +1,7 @@
+---
+orphan: true
+---
+
 # BucketFs Utily Python 0.1.0, released XYZ
 Code name: Initial implementation
 
@@ -14,4 +18,4 @@ Code name: Initial implementation
 ### Refactorings
 
   - #15: Remove DepHell dependency, because it is not maintained anymore
-  - #42: Moved BucketFS Location over from exasol_data_science_utils_python
+  - #42: Moved BucketFS Location over from exasol_data_science_utils_python

doc/deploy-to-github-pages.sh

@@ -74,6 +74,9 @@ checkout_target_branch_as_worktree() {
 }
 
 build_and_copy_documentation() {
+  echo "Build api-doc"
+  sphinx-apidoc -T -d 1 --separate -o "$SCRIPT_DIR/api" "$SCRIPT_DIR/../exasol_bucketfs_utils_python"
+
   echo "Build with sphinx"
   sphinx-build -M html "$SCRIPT_DIR" "$BUILD_DIR" -W
 

githooks/install.sh

@@ -26,7 +26,8 @@ GITHOOKS_PATH="$(readlink -f "${GITHOOKS_PATH}")"
 copy_hook() {
     local SCRIPT_PATH="$SCRIPT_DIR/$1"
     local GITHOOK_PATH="$GITHOOKS_PATH/$2"
-    local RELATIVE_PATH=$(realpath --relative-to="$GITHOOKS_PATH" "$SCRIPT_PATH")
+    local RELATIVE_PATH
+    RELATIVE_PATH="$(realpath --relative-to="$GITHOOKS_PATH" "$SCRIPT_PATH")"
     pushd "$GITHOOKS_PATH" > /dev/null
     if [ -e "$GITHOOK_PATH" ] || [ -L "$GITHOOK_PATH" ]
     then

githooks/update_setup_py.sh

@@ -4,7 +4,6 @@ set -o nounset
 set -o pipefail
 
 # define colors for use in output
-green='\033[0;32m'
 no_color='\033[0m'
 grey='\033[0;90m'
 
@@ -29,9 +28,9 @@ then
 fi
 poetry build > /dev/null
 pushd dist > /dev/null
-tar_file=$(ls *.tar.gz)
+tar_file=$(ls -- *.tar.gz)
 extracted_dir=${tar_file%.tar.gz}
-tar -xf $tar_file
+tar -xf "$tar_file"
 cp "$extracted_dir/setup.py" ../setup.py
 rm -r "$extracted_dir"
 popd > /dev/null