linting (#14)

- linting
- fixing auto-update
- markdown help
- applied asciiart & copyright
- switch master to main branch
- fixed broken merge

Author: fabiocicerchia

.github/linters/.hadolint.yml

@@ -1,3 +1,4 @@
 ignored:
   - DL3008 # Pin versions in apt get install. Instead of `apt-get install <package>` use `apt-get install <package>=<version>`
-  - DL3018 # Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`
+  - DL3018 # Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`
+  - DL3033 # Specify version with `yum install -y <package>-<version>`.

.github/linters/.markdown-lint.yml

@@ -1 +1,8 @@
 line-length: false
+MD033:
+  allowed_elements:
+    - details
+    - summary
+MD026:
+  punctuation: ".,;:!。，；：！？"
+MD038: false

.github/workflows/anchore-analysis.yml

@@ -5,7 +5,12 @@
 # information on Anchore's container image scanning tool Grype, see
 # https://github.com/anchore/grype
 name: Anchore Container Scan
-on: push
+
+on:
+  push:
+    branches:
+      - main
+
 jobs:
   Anchore-Build-Scan:
     runs-on: ubuntu-latest
@@ -15,7 +20,9 @@ jobs:
 
     - name: Check docker changes
       id: docker_changes
-      run: git diff-tree --no-commit-id --name-only -r HEAD nginx tpl | wc -l | tr -d ' '
+      run: git diff-tree --no-commit-id --name-only -r ${SHA:-HEAD} nginx tpl | wc -l | tr -d ' '
+      env:
+        SHA: ${{ github.sha }}
 
     - name: Build the Docker image
       if: steps.docker_changes.output != '0'

.github/workflows/autoupdate.yml

@@ -16,6 +16,15 @@ jobs:
         id: auto-update-and-commit
         run: make auto-update-and-commit
 
+      - name: Archive metadata artifacts
+        uses: actions/upload-artifact@v2
+        if: steps.auto-update-and-commit.outputs == '0'
+        with:
+          name: broken-docker-update
+          path: /tmp/generate-supported-versions
+          retention-days: 5
+          if-no-files-found: ignore
+
       - name: cancelling
         uses: andymckay/[email protected]
         if: steps.auto-update-and-commit.outputs == '0'
@@ -37,7 +46,9 @@ jobs:
 
       - name: Check docker changes
         id: docker_changes
-        run: git diff-tree --no-commit-id --name-only -r HEAD nginx tpl | wc -l | tr -d ' '
+        run: git diff-tree --no-commit-id --name-only -r ${SHA:-HEAD} nginx tpl | wc -l | tr -d ' '
+        env:
+          SHA: ${{ github.sha }}
 
       - name: Cleanup metadata artifacts
         run: rm -rf docs/metadata/*
@@ -53,11 +64,11 @@ jobs:
 
       - name: Log into registry
         run: echo "${{ secrets.DOCKER_HUB_TOKEN }}" | docker login  -u ${{ github.actor }} --password-stdin
-        if: github.ref == 'refs/heads/master' && steps.docker_changes.output != '0'
+        if: github.ref == 'refs/heads/main' && steps.docker_changes.output != '0'
 
       - name: Push images
         run: make push-${{ matrix.distro }}
-        if: github.ref == 'refs/heads/master' && steps.docker_changes.output != '0'
+        if: github.ref == 'refs/heads/main' && steps.docker_changes.output != '0'
 
       - name: Archive metadata artifacts
         uses: actions/upload-artifact@v2
@@ -112,7 +123,7 @@ jobs:
 
       - name: Push metadata
         run: make auto-commit-metadata
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'
 
   auto_tag:
     name: Create Release

.github/workflows/linter.yml

@@ -1,13 +1,6 @@
 name: Lint Code Base
 
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    type:
-      - opened
-      - synchronize
+on: push
 
 jobs:
   build:
@@ -24,4 +17,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           VALIDATE_ALL_CODEBASE: true
           DOCKERFILE_HADOLINT_FILE_NAME: .hadolint.yml
-          FILTER_REGEX_EXCLUDE: "nginx/(1.17.10|1.18.0|1.19.0|1.19.1|1.19.2)"
+          FILTER_REGEX_EXCLUDE: "nginx/(1.17.10|1.18.0|1.19.0|1.19.1|1.19.2)|tpl/.+.sh"

.github/workflows/main.yml

@@ -3,7 +3,7 @@ name: Docker Builds
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     type:
       - opened
@@ -23,7 +23,9 @@ jobs:
 
       - name: Check docker changes
         id: docker_changes
-        run: git diff-tree --no-commit-id --name-only -r HEAD nginx tpl | wc -l | tr -d ' '
+        run: git diff-tree --no-commit-id --name-only -r ${SHA:-HEAD} nginx tpl | wc -l | tr -d ' '
+        env:
+          SHA: ${{ github.sha }}
 
       - name: Cleanup metadata artifacts
         run: rm -rf docs/metadata/*
@@ -39,11 +41,11 @@ jobs:
 
       - name: Log into registry
         run: echo "${{ secrets.DOCKER_HUB_TOKEN }}" | docker login  -u ${{ github.actor }} --password-stdin
-        if: github.ref == 'refs/heads/master' && steps.docker_changes.output != '0'
+        if: github.ref == 'refs/heads/main' && steps.docker_changes.output != '0'
 
       - name: Push images
         run: make push-${{ matrix.distro }}
-        if: github.ref == 'refs/heads/master' && steps.docker_changes.output != '0'
+        if: github.ref == 'refs/heads/main' && steps.docker_changes.output != '0'
 
       - name: Archive metadata artifacts
         uses: actions/upload-artifact@v2
@@ -99,4 +101,4 @@ jobs:
 
       - name: Push metadata
         run: make auto-commit-metadata
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/main'

.github/workflows/snyk-analysis.yml

@@ -7,7 +7,12 @@
 # fail PR checks for new vulnerabilities, see https://github.com/snyk/actions/
 
 name: Snyk Container
-on: push
+
+on:
+  push:
+    branches:
+      - main
+
 jobs:
   snyk:
     runs-on: ubuntu-latest
@@ -16,7 +21,9 @@ jobs:
 
     - name: Check docker changes
       id: docker_changes
-      run: git diff-tree --no-commit-id --name-only -r HEAD nginx tpl | wc -l | tr -d ' '
+      run: git diff-tree --no-commit-id --name-only -r ${SHA:-HEAD} nginx tpl | wc -l | tr -d ' '
+      env:
+        SHA: ${{ github.sha }}
 
     - name: Build a Docker image
       if: steps.docker_changes.output != '0'