Test super-linter workflow (#536)

* test super-linter workflow * dummy commit * dummy commit * superlint renovate * superlint bash_exec * superlint bash * superlint GHA * superlint json * superlint markdown * test hadolint deactivation * test hadolint deactivation * test hadolint deactivation * test hadolint deactivation * superlint docker * configure bash severity * update linting workflow remote * review AW * dockerfile cosmetics
actinia-org · Jul 11, 2024 · b590dfa · b590dfa
1 parent a8f9e0f
commit b590dfa
Show file tree

Hide file tree

Showing 41 changed files with 687 additions and 1,412 deletions.
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -40,7 +40,7 @@ jobs:
         name: Create tag name
         run: |
           tag=${DOCKERHUB_REPOSITORY}:latest
-          echo "tags=$tag" >> $GITHUB_OUTPUT
+          echo "tags=$tag" >> "$GITHUB_OUTPUT"
       - name: log
         run: echo ${{ steps.meta.outputs.tags }}
       - name: Set up QEMU

diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -1,4 +1,4 @@
-name: Python Flake8, black and pylint code quality check
+name: Linting and code quality check
 
 on: [push, pull_request]
 
@@ -8,3 +8,4 @@ jobs:
     with:
       # set pylint-version to empty string to skip the pylint workflow
       pylint-version: ''
+      BASH_SEVERITY: 'warning'
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -23,7 +23,7 @@ jobs:
         run: |
           # already done in update-version workflow,
           # repeated here if other workflow is slower.
-          OLD_VERSION=`cat pyproject.toml | grep ^version | cut -d '"' -f 2`
+          OLD_VERSION=$(grep ^version pyproject.toml | cut -d '"' -f 2)
           OLD_VERSION="\"$OLD_VERSION\""
           NEW_VERSION="\"$GITHUB_REF_NAME\""
           sed -i "s+version = $OLD_VERSION+version = $NEW_VERSION+g" pyproject.toml

diff --git a/.github/workflows/update-version.yml b/.github/workflows/update-version.yml
@@ -14,7 +14,7 @@ jobs:
           fetch-depth: 0
       - name: Update Version Number
         run: |
-          OLD_VERSION=`cat pyproject.toml | grep ^version | cut -d '"' -f 2`
+          OLD_VERSION=$(grep ^version pyproject.toml | cut -d '"' -f 2)
           OLD_VERSION="\"$OLD_VERSION\""
           NEW_VERSION="\"$GITHUB_REF_NAME\""
           sed -i "s+version = $OLD_VERSION+version = $NEW_VERSION+g" pyproject.toml

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,3 @@
+---
+default: true
+MD034: false # no-bare-urls
diff --git a/.shellcheckrc b/.shellcheckrc
@@ -0,0 +1,3 @@
+# SC2086 (info): Double quote to prevent globbing and word splitting.
+# https://www.shellcheck.net/wiki/SC2086
+disable=SC2086
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -9,14 +9,13 @@
 				"tag": "actiniacore:latest",
 				"dockerfile": "${workspaceFolder}/docker/actinia-core-dev/Dockerfile",
 				"context": "${workspaceFolder}"
-				// "pull": true // use this when an newer image is available
 			}
 		},
 		{
 			"label": "start-redis",
 			"type": "shell",
 			"command": "docker-compose -f docker/docker-compose-dev.yml up -d redis redis-queue",
-			"isBackground": true,
+			"isBackground": true
 		},
 		{
 			"type": "docker-run",
@@ -30,7 +29,6 @@
 				"args": [
 					"run",
 					"--no-debugger",
-					// "--no-reload",
 					"--host",
 					"0.0.0.0",
 					"--port",
@@ -39,8 +37,6 @@
 			},
 			"dockerRun": {
 				"remove": true,
-				// network is needed when connecting to redis
-				// while not using docker-compose for startup
 				"network": "docker_actinia-dev",
 				"ports": [
 				  {
@@ -50,14 +46,11 @@
 				],
 				"customOptions": "--ip 172.18.0.11",
 				"volumes": [
-					// mount local source code for instant reload
-					// on changes
 					{
 				    	"localPath": "${workspaceFolder}",
 					    "containerPath": "/src/actinia_core",
 					    "permissions": "rw"
 				    },
-					// mount GRASS DBs
 					{
 				    	"localPath": "${workspaceFolder}/docker/actinia-core-data/grassdb",
 					    "containerPath": "/actinia_core/grassdb",
@@ -68,7 +61,6 @@
 					    "containerPath": "/actinia_core/userdata",
 					    "permissions": "rw"
 				    },
-					// mount other data
 					{
 				    	"localPath": "${workspaceFolder}/docker/actinia-core-data/pgpass",
 					    "containerPath": "/mnt/pgpass",

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,23 +1,27 @@
-# About actinia
-
-The cloud based geoprocessing platform actinia is able to ingest and
-analyse large volumes of data already present in the cloud. Due to the
-scalability of the cloud platform insights and tailor made information
-are delivered in near real-time.
-
-## The name actinia?
-
-We adopted the name "actinia" from [sea anemones](https://en.wikipedia.org/wiki/Sea_anemone)
-which are a group of marine, predatory animals of the order Actiniaria which are named
-after the terrestrial flowering plant anemone with its colourful
-appearance. The idea is that the cloud based geoprocessing engine
-actinia filters information out of the rather unlimited amount of data
-available.
-
-Originally started as "GRaaS" - GRASS GIS as a Service - project, we changed the
-name to actinia in 2017.
-
-# How to contribute to the actinia project
+# How to contribute
+
+>
+> ## About actinia
+>
+> The cloud based geoprocessing platform actinia is able to ingest and
+> analyse large volumes of data already present in the cloud. Due to the
+> scalability of the cloud platform insights and tailor made information
+> are delivered in near real-time.
+>
+> ## The name actinia?
+>
+> We adopted the name "actinia" from [sea anemones](https://en.wikipedia.org/wiki/Sea_anemone)
+> which are a group of marine, predatory animals of the order Actiniaria which are named
+> after the terrestrial flowering plant anemone with its colourful
+> appearance. The idea is that the cloud based geoprocessing engine
+> actinia filters information out of the rather unlimited amount of data
+> available.
+>
+> Originally started as "GRaaS" - GRASS GIS as a Service - project, we changed the
+> name to actinia in 2017.
+>
+
+## How to contribute to the actinia project
 
 Actinia has been mainly developed by open source GIS developers of the GRASS GIS project.
 Since the project is open source, all users, regardless of the profession or skill level,
@@ -138,7 +142,7 @@ This section collects best practices for the use of git in actinia development.
 Indicate a component name (eg a driver name), a short description and when
 relevant, a reference to a issue (with 'fixes #' if it actually fixes it)
 
-```
+```bash
 COMPONENT_NAME: fix bla bla (fixes #1234)
 
 Details here...

diff --git a/README.md b/README.md
@@ -43,15 +43,15 @@ Required system packages:
 
 And then install from pypi:
 
-```
+```bash
 pip install actinia-core
 ```
 
 ## Installation with Docker
 
 Docker images are available from https://hub.docker.com/r/mundialis/actinia-core
 
-```
+```bash
 docker pull mundialis/actinia-core
 ```
 

diff --git a/RELEASE.md b/RELEASE.md
@@ -1,4 +1,4 @@
-Steps when releasing actinia-core:
+# Steps when releasing actinia-core
 
 ## 0. Steps for major updates
 
@@ -7,7 +7,7 @@ Steps when releasing actinia-core:
 ## 1. Prepare release and version
 
 - Run in terminal
-  ```
+  ```bash
   ESTIMATED_VERSION=3.0.1
 
   gh api repos/actinia-org/actinia-core/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body
@@ -32,7 +32,7 @@ Steps when releasing actinia-core:
 ## 4. Update changelog
 
 - Run in terminal
-  ```
+  ```bash
   curl https://api.github.com/repos/actinia-org/actinia-core/releases/latest | jq -r '. | "## [\(.tag_name)] - \(.published_at | strptime("%Y-%m-%dT%H:%M:%SZ") | strftime("%Y-%m-%d"))\nreleased from \(.target_commitish)\n\(.body) \n"'
   ```
 - Copy the output to the top of the release list in [CHANGELOG.md](https://github.com/actinia-org/actinia-core/blob/main/CHANGELOG.md)
@@ -49,7 +49,7 @@ Steps when releasing actinia-core:
 
 - Optionally update version in https://github.com/actinia-org/actinia-docker/blob/main/actinia-alpine/Dockerfile#L23
 
-## Outcome:
+## Outcome
 
 - Automatically a new docker image with the new tag will be created and pushed to [Dockerhub](https://hub.docker.com/r/mundialis/actinia-core/tags)
 - Automatically new source and build distributions are created and pulished on [PyPI](https://pypi.org/project/actinia-core/)