Merge pull request #56 from dokku-community/lint-ci

ci: add linting to ci

Author: josegonzalez

.editorconfig

@@ -0,0 +1,24 @@
+root = true
+
+[*]
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[Makefile]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+
+[*.mk]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+
+[*.{go,mod}]
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+
+[*.md]
+tab_width = 4

.github/dependabot.yaml

@@ -0,0 +1,10 @@
+---
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    labels:
+      - "type: dependencies"

.github/linters/.markdown-lint.yaml

@@ -0,0 +1,37 @@
+---
+default: true
+
+# Line length
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013
+MD013: false
+
+# Inline HTML
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
+MD033: false
+
+# List indentation
+# 2 spaces breaks list formatting in mkdocs
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md007
+MD007:
+  indent: 4
+
+# Fenced code blocks should have a language specified
+# We use a second, un-languaged code block to denote the output
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md040
+MD040: false
+
+# Blank line inside blockquote
+# This is typically done when a section has a "New as of" or "Warning" in addition to a note
+# May wish to take advantage of github-style admonitions
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md028
+MD028: false
+
+# No duplicate headers
+# HISTORY.md has a ton of these
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024
+MD024: false
+
+# First line h1
+# The issue template doesn't have one
+# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041
+MD041: false

.github/linters/.yamllint.yaml

@@ -0,0 +1,8 @@
+---
+extends: default
+
+rules:
+  line-length: disable
+
+ignore:
+  - plugins/scheduler-k3s/templates/*

.github/workflows/lint.yaml

@@ -0,0 +1,66 @@
+---
+name: "lint"
+
+# yamllint disable-line rule:truthy
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - "master"
+
+concurrency:
+  group: lint-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  markdown-lint:
+    name: markdown-lint
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          cache-dependency-path: ".github/workflows/lint.yaml"
+      - name: Install markdownlint-cli
+        run: npm install -g [email protected]
+      - name: Run markdown-lint
+        run: markdownlint -c .github/linters/.markdown-lint.yaml *.md **/*.md
+
+  shellcheck:
+    name: shellcheck
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+      - name: Run shellcheck
+        uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38 # 2.0.0
+
+  shfmt:
+    name: shfmt
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+      - name: Run shfmt
+        uses: luizm/action-sh-checker@17bd25a6ee188d2b91f677060038f4ba37ba14b2 # v0.9.0
+        env:
+          SHFMT_OPTS: -l -bn -ci -i 2 -d
+        with:
+          sh_checker_shellcheck_disable: true
+
+  yamllint:
+    name: yamllint
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Clone
+        uses: actions/checkout@v4
+      - name: Run yamllint
+        uses: ibiqlik/action-yamllint@2576378a8e339169678f9939646ee3ee325e845c # v3.1.1
+        with:
+          config_file: ".github/linters/.yamllint.yaml"

.shellcheckrc

@@ -0,0 +1,2 @@
+# SC1091 - Not following: FILE: does not exist (No such file or directory) - <https://github.com/koalaman/shellcheck/wiki/SC1091>
+disable=SC1091

README.md

@@ -1,5 +1,4 @@
-dokku-apt
-=========
+# dokku-apt
 
 Inject deb packages into dokku based on files in project.
 
@@ -48,7 +47,7 @@ A config file for apt, as documented [here](https://linux.die.net/man/5/apt.conf
 
 Example
 
-```
+```shell
 Acquire::http::Proxy "http://user:[email protected]:8888/";
 ```
 
@@ -58,7 +57,7 @@ A file that can contain environment variables. Note that this is sourced, and sh
 
 Example
 
-```
+```shell
 export ACCEPT_EULA=y
 ```
 
@@ -72,7 +71,7 @@ Requires an empty line at end of file.
 
 Example
 
-```
+```shell
 https://packages.microsoft.com/keys/microsoft.asc
 ```
 
@@ -82,7 +81,7 @@ A file that contains [APT Preferences](https://wiki.debian.org/AptPreferences).
 
 Example:
 
-```
+```shell
 APT {
   Install-Recommends "false";
 }
@@ -93,7 +92,8 @@ APT {
 Overrides the `/etc/apt/sources.list` file. An empty file may be provided in order to remove upstream packages.
 
 Example:
-```
+
+```shell
 deb http://archive.ubuntu.com/ubuntu/ bionic main universe
 deb http://archive.ubuntu.com/ubuntu/ bionic-security main universe
 deb http://archive.ubuntu.com/ubuntu/ bionic-updates main universe
@@ -107,18 +107,19 @@ This file should contain apt packages to install, accepts multiple packages per
 If this file is included, an `apt-get update` is triggered beforehand.
 
 Example:
-```
+
+```shell
 nginx
 unifont
 ```
 
 #### Specifying package versions
 
-You can specify a package version with '=1.2.3' after the package name. 
+You can specify a package version with '=1.2.3' after the package name.
 
 Example:
 
-```
+```shell
 libgd2-dev=2.1.1
 ```
 
@@ -132,7 +133,7 @@ Requires an empty line at end of file.
 
 Example:
 
-```
+```shell
 ppa:nginx/stable
 deb http://archive.ubuntu.com/ubuntu quantal multiverse
 ```
@@ -144,7 +145,7 @@ Requires an empty line at end of file.
 
 Example:
 
-```
+```shell
 ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true
 ```
 
@@ -158,7 +159,7 @@ Packages are installed in lexicographical order. As such, if any packages depend
 
 Example:
 
-```
+```shell
 $ ls dpkg-packages/
 your-package-0_0.0.1.deb
 ```

builder-create-dokku-image

@@ -7,8 +7,9 @@ source "$PLUGIN_AVAILABLE_PATH/apt/internal-functions"
 
 hook-apt-builder-create-dokku-image() {
   declare BUILDER_TYPE="$1" APP="$2" SOURCECODE_WORK_DIR="$3" DOKKU_IMAGE="$4"
-  local IMAGE="dokku/$APP" DIR=/tmp/apt
+  local IMAGE="dokku/$APP"
   local COMMAND CONTENT_SHA DOCKER_COMMIT_LABEL_ARGS DOCKER_RUN_LABEL_ARGS
+  local TMP_WORK_DIR DOCKER_ARGS
 
   if [[ -d "$SOURCECODE_WORK_DIR/dpkg-packages" ]]; then
     dokku_log_info1 "Rebuilding extended app image due to dpkg-packages usage"
@@ -20,7 +21,8 @@ hook-apt-builder-create-dokku-image() {
     return
   fi
 
-  local TMP_WORK_DIR=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
+  TMP_WORK_DIR=$(mktemp -d "/tmp/dokku-${DOKKU_PID}-${FUNCNAME[0]}.XXXXXX")
+  # shellcheck disable=SC2064
   trap "rm -rf '$TMP_WORK_DIR' >/dev/null" RETURN
   fn-apt-populate-work-dir "$SOURCECODE_WORK_DIR" "$TMP_WORK_DIR"
 
@@ -32,6 +34,7 @@ hook-apt-builder-create-dokku-image() {
 
   dokku_log_info1 "Creating extended app image with custom system packages"
   pushd "$TMP_WORK_DIR" >/dev/null
+  # shellcheck disable=SC2086
   CID=$(tar -c . | "$DOCKER_BIN" container run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -i -a stdin "$DOKKU_IMAGE" /bin/bash -c "mkdir -p /tmp/apt && tar -xC /tmp/apt")
   popd >/dev/null
   if test "$("$DOCKER_BIN" container wait "$CID")" -ne 0; then
@@ -43,12 +46,13 @@ hook-apt-builder-create-dokku-image() {
   "$DOCKER_BIN" container commit "${DOCKER_COMMIT_LABEL_ARGS[@]}" "$CID" "$IMAGE:apt" >/dev/null
   "$DOCKER_BIN" container rm "$CID" &>/dev/null || true
 
-  local DOCKER_ARGS=$(: | plugn trigger docker-args-build "$APP" "$BUILDER_TYPE")
+  DOCKER_ARGS=$(: | plugn trigger docker-args-build "$APP" "$BUILDER_TYPE")
   declare -a ARG_ARRAY
   eval "ARG_ARRAY=($DOCKER_ARGS)"
 
   COMMAND="$(fn-apt-command "$APP" "$DOKKU_IMAGE" "/tmp/apt")"
   DOCKER_RUN_LABEL_ARGS="--label=com.dokku.app-name=$APP"
+  # shellcheck disable=SC2086
   CID=$("$DOCKER_BIN" container run "${DOCKER_RUN_LABEL_ARGS[@]}" $DOKKU_GLOBAL_RUN_ARGS -d "${ARG_ARRAY[@]}" "$IMAGE:apt" /bin/bash -e -c "$COMMAND")
 
   "$DOCKER_BIN" container attach "$CID"

builder-dokku-image

@@ -5,6 +5,7 @@ export DOCKER_BIN=${DOCKER_BIN:="docker"}
 source "$PLUGIN_AVAILABLE_PATH/apt/internal-functions"
 
 hook-apt-builder-dokku-image() {
+  # shellcheck disable=SC2034
   declare BUILDER_TYPE="$1" APP="$2" SOURCECODE_WORK_DIR="$3" DOKKU_IMAGE="$4"
   local IMAGE="dokku/$APP"
   local CONTENT_SHA

internal-functions

@@ -9,6 +9,7 @@ fn-clean-extended-app-images() {
   local images
 
   # remove dangling extended app images
+  # shellcheck disable=SC2046
   "$DOCKER_BIN" image rm $("$DOCKER_BIN" image ls --format 'dangling=true' --format "label=com.dokku.app-name=sha-$APP" --quiet) &>/dev/null || true
 
   images="$("$DOCKER_BIN" image ls --filter "label=com.dokku.app-name=sha-$APP" --quiet)"
@@ -21,7 +22,7 @@ fn-clean-extended-app-images() {
 
 fn-apt-fetch-sha() {
   declare SOURCECODE_WORK_DIR="$1" DOKKU_IMAGE="$2"
-  local APT_FILES CONTENT INJECT_PACKAGES file
+  local APT_FILES CONTENT INJECT_PACKAGES file file_contents
 
   if [[ -d "$SOURCECODE_WORK_DIR/dpkg-packages" ]]; then
     return
@@ -31,7 +32,7 @@ fn-apt-fetch-sha() {
   for file in "${APT_FILES[@]}"; do
     if [[ -f "$SOURCECODE_WORK_DIR/$file" ]]; then
       INJECT_PACKAGES=true
-      local file_contents=$(<$SOURCECODE_WORK_DIR/$file)
+      file_contents="$(<"$SOURCECODE_WORK_DIR/$file")"
       CONTENT="${CONTENT}\n${file}\n${file_contents}"
     fi
   done
@@ -43,7 +44,7 @@ fn-apt-fetch-sha() {
   local image_digest
   image_digest="$("$DOCKER_BIN" image inspect --format='{{index .RepoDigests 0}}' "$DOKKU_IMAGE" 2>/dev/null || echo "$DOKKU_IMAGE")"
 
-  echo -n "$(<$PLUGIN_AVAILABLE_PATH/apt/plugin.toml)${image_digest}${CONTENT}" | sha256sum | cut -d " " -f 1
+  echo -n "$(<"$PLUGIN_AVAILABLE_PATH/apt/plugin.toml")${image_digest}${CONTENT}" | sha256sum | cut -d " " -f 1
 }
 
 fn-apt-populate-work-dir() {

pre-build

@@ -8,7 +8,7 @@ source "$PLUGIN_AVAILABLE_PATH/apt/internal-functions"
 hook-apt-pre-build() {
   declare BUILDER_TYPE="$1" APP="$2" SOURCECODE_WORK_DIR="$3"
   local IMAGE="dokku/$APP" DIR=/app
-  local CID COMMAND DOCKER_COMMIT_LABEL_ARGS
+  local CID COMMAND DOCKER_COMMIT_LABEL_ARGS DOCKER_ARGS
   # This trigger is only called with apps using buildpacks, so it's safe to assume this:
   local BUILDER_TYPE=herokuish
 
@@ -24,7 +24,7 @@ hook-apt-pre-build() {
     popd >/dev/null
   fi
 
-  local DOCKER_ARGS=$(: | plugn trigger docker-args-build "$APP" "$BUILDER_TYPE")
+  DOCKER_ARGS=$(: | plugn trigger docker-args-build "$APP" "$BUILDER_TYPE")
   declare -a ARG_ARRAY
   eval "ARG_ARRAY=($DOCKER_ARGS)"