chore(deps): update docker/setup-qemu-action action to v4.4.0

.dockerignore

@@ -1 +1 @@
-bin
+app

.editorconfig

@@ -1,12 +1,13 @@
+# Editor configuration, see http://editorconfig.org
 root = true
 
 [*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = true
+end_of_line = lf
+indent_size = 2
+indent_style = space
 insert_final_newline = false
+trim_trailing_whitespace = true
 
-[Makefile]
-indent_style = tab
+[{Makefile,*.go}]
+indent_style = tab

.gitattributes

@@ -1 +0,0 @@
-Makefile eol=lf

.gitea/workflows/golang-linters.yaml

@@ -0,0 +1,29 @@
+name: "Lint Golang files"
+
+on:
+  pull_request:
+    types: [ "opened", "reopened", "synchronize" ]
+  push:
+    branches: [ '**' ]
+    tags-ignore: [ '**' ]
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: "Run golang CI linter"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        go: [ stable ]
+        os: [ ubuntu-latest-amd64, ubuntu-latest-arm64 ]
+    steps:
+    - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
+    - uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0
+      with:
+        go-version: ${{ matrix.go }}
+    - uses: golangci/golangci-lint-action@ba0d7d2ec06a0ea1cb5fa41b2e4a3ab91d21278a # v9.3.0
+      with:
+        version: v2.9.0 # renovate: datasource=github-releases depName=golangci/golangci-lint

.gitea/workflows/golang-tests.yaml

@@ -0,0 +1,42 @@
+name: "Run Golang tests"
+
+on:
+  pull_request:
+    types: [ "opened", "reopened", "synchronize" ]
+  push:
+    branches: [ '**' ]
+    tags-ignore: [ '**' ]
+  workflow_dispatch: {}
+
+jobs:
+  # integration-test:
+  #   name: "Run integration tests"
+  #   runs-on: ${{ matrix.os }}
+  #   strategy:
+  #     matrix:
+  #       go: [ stable ]
+  #       os: [ ubuntu-latest-amd64, ubuntu-latest-arm64 ]
+  #   steps:
+  #   - uses: actions/checkout@v4.3.0
+  #   - uses: actions/setup-go@v5.5.0
+  #     with:
+  #       go-version: ${{ matrix.go }}
+  #   - env:
+  #       GOPROXY: ${{ vars.GOPROXY }}
+  #     run: make test/integration
+
+  unit-test:
+    name: "Run unit tests"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        go: [ stable ]
+        os: [ ubuntu-latest-amd64, ubuntu-latest-arm64 ]
+    steps:
+    - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
+    - uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0
+      with:
+        go-version: ${{ matrix.go }}
+    - env:
+        GOPROXY: ${{ vars.GOPROXY }}
+      run: make test/unit

.gitea/workflows/markdown-linters.yaml

@@ -0,0 +1,19 @@
+name: "Lint Markdown files"
+
+on:
+  pull_request:
+    types: [ "opened", "reopened", "synchronize" ]
+  push:
+    branches: [ '*' ]
+    tags-ignore: [ '*' ]
+  workflow_dispatch: {}
+
+jobs:
+  markdown-lint:
+    name: "Run markdown linter"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
+    - uses: DavidAnson/markdownlint-cli2-action@ded1f9488f68a970bc66ea5619e13e9b52e601cd # v23.2.0
+      with:
+        globs: '**/*.md'

.gitea/workflows/release.yaml

@@ -0,0 +1,56 @@
+name: "Release"
+
+on:
+  push:
+    tags: [ '**' ]
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: "Release application"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
+      with:
+        fetch-depth: 0
+    - uses: docker/setup-qemu-action@99012661954931238ded8c8b007157a8430204e1 # v4.4.0
+      with:
+        image: harbor.cryptic.systems/docker/tonistiigi/binfmt:latest
+    - uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0
+      with:
+        go-version: stable
+    - uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
+      with:
+        registry: git.cryptic.systems
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GIT_CRYPTIC_SYSTEMS_PACKAGE_REGISTRY_TOKEN }}
+    - env:
+        GITEA_TOKEN: ${{ secrets.GIT_CRYPTIC_SYSTEMS_PACKAGE_REGISTRY_TOKEN }}
+        GONOSUMDB: ${{ vars.GONOSUMDB }}
+        GOPROXY: ${{ vars.GOPROXY }}
+      uses: goreleaser/goreleaser-action@f06c13b6b1a9625abc9e6e439d9c05a8f2190e94 # v7.2.3
+      with:
+        version: v2.17.1 # renovate: datasource=github-releases depName=goreleaser/goreleaser
+        args: release --clean
+
+  sync-to-hub-docker-io:
+    needs:
+    - release
+    runs-on: ubuntu-latest
+    steps:
+    - name: Copy images to docker.io
+      run: |
+        TAG=$(echo ${{ github.ref_name }} | sed 's/v//gm')
+
+        apt-get update --yes
+        apt-get install --yes skopeo
+        skopeo copy \
+          --all \
+          --dest-password ${{ secrets.DOCKER_IO_PASSWORD }} \
+          --dest-username ${{ secrets.DOCKER_IO_USERNAME }} \
+          --src-password ${{ secrets.GIT_CRYPTIC_SYSTEMS_PACKAGE_REGISTRY_TOKEN }} \
+          --src-username volker.raschek \
+            docker://git.cryptic.systems/volker.raschek/docker-hub-description-updater:${TAG} \
+            docker://docker.io/volkerraschek/dhcu:${TAG}

.gitea/workflows/update-docker-hub-description.yaml

@@ -0,0 +1,20 @@
+name: Update Docker Hub Description
+
+on:
+  push:
+    branches: [ 'master' ]
+    paths: [ 'README.md' ]
+  workflow_dispatch: {}
+
+jobs:
+  update-description-on-hub-docker-io:
+    runs-on:
+    - ubuntu-latest
+    steps:
+    - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
+    - uses: peter-evans/dockerhub-description@1b9a80c056b620d92cedb9d9b5a223409c68ddfa # v5.0.0
+      with:
+        username: ${{ secrets.DOCKER_IO_USERNAME }}
+        password: ${{ secrets.DOCKER_IO_PASSWORD }}
+        repository: volkerraschek/dhdu
+        readme-filepath: README.md

.gitignore

@@ -1,4 +1,3 @@
-/bin
-/dhd
-
-**/bindata*.go
+docker-hub-description-updater
+coverage.txt
+dist

.golangci.yaml

@@ -0,0 +1,13 @@
+version: "2"
+linters:
+  default: standard
+  enable:
+  - errname
+  - gosec
+
+  exclusions:
+    rules: []
+    warn-unused: true
+
+run:
+  tests: true

.goreleaser.yaml

@@ -0,0 +1,175 @@
+project_name: docker-hub-description-updater
+
+archives:
+- formats: [ "tar.xz" ]
+  files:
+  - README.md
+  - LICENSE
+
+before:
+  hooks:
+  - go mod tidy
+
+builds:
+- main: main.go
+  binary: >-
+    {{ .ProjectName }}-
+    {{- .Version }}-
+    {{- .Os }}-
+    {{- if eq .Arch "amd64" }}amd64
+    {{- else if eq .Arch "amd64_v1" }}amd64
+    {{- else }}{{ .Arch }}{{ end }}
+    {{- if .Arm }}-{{ .Arm }}{{ end }}
+  env:
+  - CGO_ENABLED=0
+  - GONOSUMDB={{ .Env.GONOSUMDB }}
+  - GOPROXY={{ .Env.GOPROXY }}
+  goos:
+  - linux
+  goarch:
+  - amd64
+  - arm
+  - arm64
+  - riscv64
+  goarm:
+  - "6"
+  - "7"
+  flags:
+  - -trimpath
+  ldflags:
+  - -s -w -X 'main.version={{ trimprefix .Tag "v" }}'
+
+changelog:
+  filters:
+    exclude:
+    - '^chore'
+    - '^docs'
+    - '^test'
+    - Merge pull request
+    - Merge branch
+    - go mod tidy
+  format: "{{.SHA}}: {{.Message}} (@{{.AuthorUsername}})"
+  groups:
+  - title: Features
+    regexp: '^.*?feat(\([[:word:]]+\))??!?:.+$'
+    order: 0
+  - title: "Bug fixes"
+    regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
+    order: 1
+  - title: Others
+    order: 999
+  sort: asc
+  use: git
+
+dockers:
+- build_flag_templates:
+  - --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
+  - --label=org.opencontainers.image.description={{ .ProjectName }}
+  - --label=org.opencontainers.image.documentation={{ .ProjectName }}
+  - --label=org.opencontainers.image.revision={{ .FullCommit }}
+  - --label=org.opencontainers.image.source={{ .GitURL }}
+  - --label=org.opencontainers.image.title={{ .ProjectName }}
+  - --label=org.opencontainers.image.url=https://git.cryptic.systems/volker.raschek/{{ .ProjectName }}
+  - --label=org.opencontainers.image.version={{ trimprefix .Tag "v" }}
+  - --platform=linux/amd64
+  - --pull
+  dockerfile: Dockerfile
+  goarch: amd64
+  goos: linux
+  image_templates:
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-amd64'
+  skip_push: false
+  use: buildx
+
+- build_flag_templates:
+  - --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
+  - --label=org.opencontainers.image.description={{ .ProjectName }}
+  - --label=org.opencontainers.image.documentation={{ .ProjectName }}
+  - --label=org.opencontainers.image.revision={{ .FullCommit }}
+  - --label=org.opencontainers.image.source={{ .GitURL }}
+  - --label=org.opencontainers.image.title={{ .ProjectName }}
+  - --label=org.opencontainers.image.url=https://git.cryptic.systems/volker.raschek/{{ .ProjectName }}
+  - --label=org.opencontainers.image.version={{ trimprefix .Tag "v" }}
+  - --platform=linux/arm/v6
+  - --pull
+  dockerfile: Dockerfile
+  goarch: arm
+  goarm: "6"
+  goos: linux
+  image_templates:
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-arm-v6'
+  skip_push: false
+  use: buildx
+
+- build_flag_templates:
+  - --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
+  - --label=org.opencontainers.image.description={{ .ProjectName }}
+  - --label=org.opencontainers.image.documentation={{ .ProjectName }}
+  - --label=org.opencontainers.image.revision={{ .FullCommit }}
+  - --label=org.opencontainers.image.source={{ .GitURL }}
+  - --label=org.opencontainers.image.title={{ .ProjectName }}
+  - --label=org.opencontainers.image.url=https://git.cryptic.systems/volker.raschek/{{ .ProjectName }}
+  - --label=org.opencontainers.image.version={{ trimprefix .Tag "v" }}
+  - --platform=linux/arm/v7
+  - --pull
+  dockerfile: Dockerfile
+  goarch: arm
+  goarm: "7"
+  goos: linux
+  image_templates:
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-arm-v7'
+  skip_push: false
+  use: buildx
+
+- build_flag_templates:
+  - --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
+  - --label=org.opencontainers.image.description={{ .ProjectName }}
+  - --label=org.opencontainers.image.documentation={{ .ProjectName }}
+  - --label=org.opencontainers.image.revision={{ .FullCommit }}
+  - --label=org.opencontainers.image.source={{ .GitURL }}
+  - --label=org.opencontainers.image.title={{ .ProjectName }}
+  - --label=org.opencontainers.image.url=https://git.cryptic.systems/volker.raschek/{{ .ProjectName }}
+  - --label=org.opencontainers.image.version={{ trimprefix .Tag "v" }}
+  - --platform=linux/arm64
+  - --pull
+  dockerfile: Dockerfile
+  goarch: arm64
+  goos: linux
+  image_templates:
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-arm64'
+  skip_push: false
+  use: buildx
+
+- build_flag_templates:
+  - --label=org.opencontainers.image.created={{ time "2006-01-02T15:04:05Z07:00" }}
+  - --label=org.opencontainers.image.description={{ .ProjectName }}
+  - --label=org.opencontainers.image.documentation={{ .ProjectName }}
+  - --label=org.opencontainers.image.revision={{ .FullCommit }}
+  - --label=org.opencontainers.image.source={{ .GitURL }}
+  - --label=org.opencontainers.image.title={{ .ProjectName }}
+  - --label=org.opencontainers.image.url=https://git.cryptic.systems/volker.raschek/{{ .ProjectName }}
+  - --label=org.opencontainers.image.version={{ trimprefix .Tag "v" }}
+  - --platform=linux/riscv64
+  - --pull
+  dockerfile: Dockerfile
+  goarch: riscv64
+  goos: linux
+  image_templates:
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-riscv64'
+  skip_push: false
+  use: buildx
+
+docker_manifests:
+- name_template: 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}'
+  image_templates:
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-amd64'
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-arm-v6'
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-arm-v7'
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-arm64'
+  - 'git.cryptic.systems/volker.raschek/{{ .ProjectName }}:{{ trimprefix .Tag "v" }}-riscv64'
+
+gitea_urls:
+  api: https://git.cryptic.systems/api/v1
+  download: https://git.cryptic.systems
+
+version: 2

.markdownlint.yaml

@@ -0,0 +1,136 @@
+# markdownlint YAML configuration
+# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+# MD003/heading-style/header-style - Heading style
+MD003:
+  # Heading style
+  style: "atx"
+
+# MD004/ul-style - Unordered list style
+MD004:
+  style: "dash"
+
+# MD007/ul-indent - Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 2
+  # Whether to indent the first level of the list
+  start_indented: false
+
+# MD009/no-trailing-spaces - Trailing spaces
+MD009:
+  # Spaces for line break
+  br_spaces: 2
+  # Allow spaces for empty lines in list items
+  list_item_empty_lines: false
+  # Include unnecessary breaks
+  strict: false
+
+# MD010/no-hard-tabs - Hard tabs
+MD010:
+  # Include code blocks
+  code_blocks: true
+
+# MD012/no-multiple-blanks - Multiple consecutive blank lines
+MD012:
+  # Consecutive blank lines
+  maximum: 1
+
+# MD013/line-length - Line length
+MD013:
+  # Number of characters
+  line_length: 120
+  # Number of characters for headings
+  heading_line_length: 120
+  # Number of characters for code blocks
+  code_block_line_length: 120
+  # Include code blocks
+  code_blocks: false
+  # Include tables
+  tables: false
+  # Include headings
+  headings: true
+  # Strict length checking
+  strict: false
+  # Stern length checking
+  stern: false
+
+# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
+MD022:
+  # Blank lines above heading
+  lines_above: 1
+  # Blank lines below heading
+  lines_below: 1
+
+# MD025/single-title/single-h1 - Multiple top-level headings in the same document
+MD025:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD026/no-trailing-punctuation - Trailing punctuation in heading
+MD026:
+  # Punctuation characters
+  punctuation: ".,;:!。，；：！"
+
+# MD029/ol-prefix - Ordered list item prefix
+MD029:
+  # List style
+  style: "one_or_ordered"
+
+# MD030/list-marker-space - Spaces after list markers
+MD030:
+  # Spaces for single-line unordered list items
+  ul_single: 1
+  # Spaces for single-line ordered list items
+  ol_single: 1
+  # Spaces for multi-line unordered list items
+  ul_multi: 1
+  # Spaces for multi-line ordered list items
+  ol_multi: 1
+
+# MD033/no-inline-html - Inline HTML
+MD033:
+  # Allowed elements
+  allowed_elements: []
+
+# MD035/hr-style - Horizontal rule style
+MD035:
+  # Horizontal rule style
+  style: "---"
+
+# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
+MD036:
+  # Punctuation characters
+  punctuation: ".,;:!?。，；：！？"
+
+# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
+MD041:
+  # Heading level
+  level: 1
+  # RegExp for matching title in front matter
+  front_matter_title: "^\\s*title\\s*[:=]"
+
+# MD044/proper-names - Proper names should have the correct capitalization
+MD044:
+  # List of proper names
+  names: []
+  # Include code blocks
+  code_blocks: false
+
+# MD046/code-block-style - Code block style
+MD046:
+  # Block style
+  style: "fenced"
+
+# MD048/code-fence-style - Code fence style
+MD048:
+  # Code fence syle
+  style: "backtick"

.travis.yml

@@ -1,30 +0,0 @@
-services:
-- docker
-
-stages:
-- build
-# - test
-- deploy
-
-jobs:
-  include:
-  - name: "Compile golang binaries inside a container image"
-    stage: build
-    script: make container-run/all
-  # - name: "Test golang binaries inside a container image"
-  #   stage: test
-  #   script: make container-run/test
-  #   after_script: bash <(curl -s https://codecov.io/bash)
-  - name: "Deploy container-image tagged as latest"
-    stage: deploy
-    script: make container-image/push
-  - name: "Deploy container-image tagged with a git tag"
-    stage: deploy
-    script: make container-image/push VERSION=${TRAVIS_TAG} CONTAINER_IMAGE_VERSION=${TRAVIS_TAG}
-    on:
-      tags: true
-
-notifications:
-  email:
-    on_success: change
-    on_failure: change

Dockerfile

@@ -1,23 +1,5 @@
-# ARGs
-# ==================================
-ARG BASE_IMAGE
-ARG BUILD_IMAGE
-ARG EXECUTABLE_TARGET
-ARG GOPROXY
-ARG GOPRIVATE
-ARG VERSION
+FROM scratch AS build
 
-# BUILD
-# ==============================================================================
-FROM ${BUILD_IMAGE} AS build-env
+COPY docker-hub-description-updater-* /usr/bin/docker-hub-description-updater
 
-ADD ./ /workspace
-
-RUN make clean ${EXECUTABLE_TARGET} GOPROXY=${GOPROXY}
-
-# TARGET
-# ==============================================================================
-FROM ${BASE_IMAGE}
-COPY --from=build-env /workspace/${EXECUTABLE_TARGET} /usr/bin/dhdu
-RUN chmod +x /usr/bin/dhdu
-ENTRYPOINT [ "/usr/bin/dhdu" ]
+ENTRYPOINT [ "/usr/bin/docker-hub-description-updater" ]

Makefile

@@ -1,203 +1,114 @@
-# VERSION
-# If no version is specified as a parameter of make, the last git hash
-# value is taken.
-# VERSION?=$(shell git describe --abbrev=0)+hash.$(shell git rev-parse --short HEAD)
-VERSION?=0.0.0+hash.$(shell git rev-parse --short HEAD)
+EXECUTABLE=docker-hub-description-updater
+VERSION?=$(shell git describe --abbrev=0)+hash.$(shell git rev-parse --short HEAD)
 
-# GOPROXY settings
-# If no GOPROXY environment variable available, the pre-defined GOPROXY from go
-# env to download and validate go modules is used. Exclude downloading and
-# validation of all private modules which are pre-defined in GOPRIVATE. If no
-# GOPRIVATE variable defined, the variable of go env is used.
-GOPROXY?=$(shell go env GOPROXY)
-GOPRIVATE?=$(shell go env GOPRIVATE)
-
-# EXECUTABLE
-# Executable binary which should be compiled for different architecures
-EXECUTABLE:=dhdu
-
-# LINUX_EXECUTABLES AND TARGETS
-LINUX_EXECUTABLES:=\
-	linux/amd64/${EXECUTABLE} \
-	linux/arm/5/${EXECUTABLE} \
-	linux/arm/7/${EXECUTABLE}
-
-LINUX_EXECUTABLE_TARGETS:=${LINUX_EXECUTABLES:%=bin/%}
-
-# UNIX_EXECUTABLES AND TARGETS
-# Define all executables for different architectures and operation systems
-UNIX_EXECUTABLES:=\
-	${LINUX_EXECUTABLES}
-
-UNIX_EXECUTABLE_TARGETS:=\
-	${LINUX_EXECUTABLE_TARGETS}
-
-# EXECUTABLE_TARGETS
-# Include all UNIX and Windows targets.
-EXECUTABLES:=\
-	${UNIX_EXECUTABLES}
-
-EXECUTABLE_TARGETS:=\
-	${UNIX_EXECUTABLE_TARGETS}
+# Destination directory and prefix to place the compiled binaries, documentaions
+# and other files.
+DESTDIR?=
+PREFIX?=/usr/local
 
 # CONTAINER_RUNTIME
 # The CONTAINER_RUNTIME variable will be used to specified the path to a
-# container runtime. This is needed to start and run a container images.
-CONTAINER_RUNTIME?=$(shell which docker)
+# container runtime. This is needed to start and run a container image.
+CONTAINER_RUNTIME?=$(shell which podman)
 
-# BUILD_IMAGE
-# Definition of the container build image, in which the Binary are compiled from
-# source code
-BUILD_IMAGE_REGISTRY:=docker.io
-BUILD_IMAGE_NAMESPACE:=volkerraschek
-BUILD_IMAGE_NAME:=build-image
-BUILD_IMAGE_VERSION:=latest
-BUILD_IMAGE_FULL=${BUILD_IMAGE_REGISTRY}/${BUILD_IMAGE_NAMESPACE}/${BUILD_IMAGE_NAME}:${BUILD_IMAGE_VERSION:v%=%}
-BUILD_IMAGE_SHORT=${BUILD_IMAGE_NAMESPACE}/${BUILD_IMAGE_NAME}:${BUILD_IMAGE_VERSION:v%=%}
+# DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_NAME
+# Defines the name of the new container to be built using several variables.
+DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_NAME:=git.cryptic.systems
+DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_USER:=volker.raschek
 
-# BASE_IMAGE
-# Definition of the base container image
-BASE_IMAGE_REGISTRY:=docker.io
-BASE_IMAGE_NAMESPACE:=library
-BASE_IMAGE_NAME:=alpine
-BASE_IMAGE_VERSION:=3.11.2
-BASE_IMAGE_FULL=${BASE_IMAGE_REGISTRY}/${BASE_IMAGE_NAMESPACE}/${BASE_IMAGE_NAME}:${BASE_IMAGE_VERSION:v%=%}
-BASE_IMAGE_SHORT=${BASE_IMAGE_NAMESPACE}/${BASE_IMAGE_NAME}:${BASE_IMAGE_VERSION:v%=%}
+DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_NAMESPACE?=${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_USER}
+DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_NAME:=${EXECUTABLE}
+DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_VERSION?=latest
+DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_FULLY_QUALIFIED=${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_NAME}/${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_NAMESPACE}/${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_NAME}:${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_VERSION}
 
-# CONTAINER_IMAGE
-# Definition of the container image
-CONTAINER_IMAGE_REGISTRY:=docker.io
-CONTAINER_IMAGE_NAMESPACE:=volkerraschek
-CONTAINER_IMAGE_NAME:=${EXECUTABLE}
-CONTAINER_IMAGE_VERSION:=latest
-CONTAINER_IMAGE_FULL=${CONTAINER_IMAGE_REGISTRY}/${CONTAINER_IMAGE_NAMESPACE}/${CONTAINER_IMAGE_NAME}:${CONTAINER_IMAGE_VERSION:v%=%}
-CONTAINER_IMAGE_SHORT=${CONTAINER_IMAGE_NAMESPACE}/${CONTAINER_IMAGE_NAME}:${CONTAINER_IMAGE_VERSION:v%=%}
-
-README_FILE:=README.md
-
-# BINARIES
+# BIN
 # ==============================================================================
-PHONY:=all
-
-${EXECUTABLE}: bin/tmp/${EXECUTABLE}
-
-all: ${EXECUTABLE_TARGETS}
-
-bin/linux/amd64/${EXECUTABLE}: bindata
+docker-hub-description-updater:
 	CGO_ENABLED=0 \
-  GOOS=linux \
-  GOARCH=amd64 \
-  GOPROXY=${GOPROXY} \
-  GOPRIVATE=${GOPRIVATE} \
-	go build -ldflags "-X main.version=${VERSION}" -o ${@}
-
-bin/linux/arm/5/${EXECUTABLE}: bindata
-	CGO_ENABLED=0 \
-  GOOS=linux \
-  GOARCH=arm \
-  GOARM=5 \
-  GOPROXY=${GOPROXY} \
-  GOPRIVATE=${GOPRIVATE} \
-	go build -ldflags "-X main.version=${VERSION}" -o ${@}
-
-bin/linux/arm/7/${EXECUTABLE}: bindata
-	CGO_ENABLED=0 \
-  GOOS=linux \
-  GOARCH=arm \
-  GOARM=5 \
-  GOPROXY=${GOPROXY} \
-  GOPRIVATE=${GOPRIVATE} \
-	go build -ldflags "-X main.version=${VERSION}" -o ${@}
-
-bin/tmp/${EXECUTABLE}: bindata
-	GOPROXY=${GOPROXY} \
-	GOPRIVATE=${GOPRIVATE} \
-	go build -ldflags "-X main.version=${VERSION}" -o ${@}
-
-# BINDATA
-# ==============================================================================
-BINDATA_TARGETS := \
-	pkg/hub/bindata.go
-
-PHONY+=bindata
-bindata: ${BINDATA_TARGETS}
-
-pkg/hub/bindata.go:
-	go-bindata -pkg hub -o ${@} README.md
-
-# TEST
-# ==============================================================================
-PHONY+=test
-test: clean bin/tmp/${EXECUTABLE}
-	REGISTRY_USER=${REGISTRY_USER} \
-	REGISTRY_PASSWORD=${REGISTRY_PASSWORD} \
-	REGISTRY_NAMESPACE=${REGISTRY_NAMESPACE} \
-	CONTAINER_IMAGE_NAME=${CONTAINER_IMAGE_NAME} \
-	README_FILE=${README_FILE} \
-		go test -v ./pkg/...
+	GOPROXY=$(shell go env GOPROXY) \
+		go build -ldflags "-X 'main.version=${VERSION}'" -o ${@} main.go
 
 # CLEAN
 # ==============================================================================
 PHONY+=clean
 clean:
-	rm --force ${EXECUTABLE} || true
-	rm --force --recursive bin || true
-	rm --force --recursive ${BINDATA_TARGETS} || true
+	rm --force --recursive docker-hub-description-updater
 
-# CONTAINER IMAGE STEPS
+# TESTS
 # ==============================================================================
-PHONY+=container-image/build/amd64
-container-image/build/amd64:
+PHONY+=test/unit
+test/unit:
+	CGO_ENABLED=0 \
+	GOPROXY=$(shell go env GOPROXY) \
+		go test -v -p 1 -coverprofile=coverage.txt -covermode=count -timeout 1200s ./pkg/...
+
+PHONY+=test/integration
+test/integration:
+	CGO_ENABLED=0 \
+	GOPROXY=$(shell go env GOPROXY) \
+		go test -v -p 1 -count=1 -timeout 1200s ./it/...
+
+PHONY+=test/coverage
+test/coverage: test/unit
+	CGO_ENABLED=0 \
+	GOPROXY=$(shell go env GOPROXY) \
+		go tool cover -html=coverage.txt
+
+# GOLANGCI-LINT
+# ==============================================================================
+PHONY+=golangci-lint
+golangci-lint:
+	golangci-lint run --concurrency=$(shell nproc)
+
+# INSTALL
+# ==============================================================================
+PHONY+=uninstall
+install: docker-hub-description-updater
+	install --directory ${DESTDIR}/etc/bash_completion.d
+	./docker-hub-description-updater completion bash > ${DESTDIR}/etc/bash_completion.d/${EXECUTABLE}
+
+	install --directory ${DESTDIR}${PREFIX}/bin
+	install --mode 0755 ${EXECUTABLE} ${DESTDIR}${PREFIX}/bin/${EXECUTABLE}
+
+	install --directory ${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}
+	install --mode 0644 LICENSE ${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}/LICENSE
+
+# UNINSTALL
+# ==============================================================================
+PHONY+=uninstall
+uninstall:
+	-rm --force --recursive \
+		${DESTDIR}/etc/bash_completion.d/${EXECUTABLE} \
+		${DESTDIR}${PREFIX}/bin/${EXECUTABLE} \
+		${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}
+
+# BUILD CONTAINER IMAGE
+# ==============================================================================
+PHONY+=container-image/build
+container-image/build:
 	${CONTAINER_RUNTIME} build \
-		--build-arg BASE_IMAGE=${BASE_IMAGE_FULL} \
-		--build-arg BUILD_IMAGE=${BUILD_IMAGE_FULL} \
-		--build-arg EXECUTABLE=${EXECUTABLE} \
-		--build-arg EXECUTABLE_TARGET=bin/linux/amd64/${EXECUTABLE} \
-		--build-arg GOPROXY=${GOPROXY} \
-		--build-arg GOPRIVATE=${GOPRIVATE} \
 		--build-arg VERSION=${VERSION} \
 		--file Dockerfile \
 		--no-cache \
-		--tag ${CONTAINER_IMAGE_FULL} \
-		--tag ${CONTAINER_IMAGE_SHORT} \
+		--pull \
+		--tag ${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_FULLY_QUALIFIED} \
 		.
 
-PHONY+=container-image/push/amd64
-container-image/push/amd64: container-image/build/amd64
-	${CONTAINER_RUNTIME} login ${CONTAINER_IMAGE_REGISTRY} \
-		--username ${CONTAINER_IMAGE_REGISTRY_USER} \
-		--password ${CONTAINER_IMAGE_REGISTRY_PASSWORD}
-	${CONTAINER_RUNTIME} push ${CONTAINER_IMAGE_FULL}
-
-# CONTAINER STEPS - BINARY
+# DELETE CONTAINER IMAGE
 # ==============================================================================
-PHONY+=container-run/all
-container-run/all:
-	$(MAKE) container-run COMMAND=${@:container-run/%=%}
+PHONY:=container-image/delete
+container-image/delete:
+	- ${CONTAINER_RUNTIME} image rm ${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_FULLY_QUALIFIED}
 
-PHONY+=${UNIX_EXECUTABLE_TARGETS:%=container-run/%}
-${UNIX_EXECUTABLE_TARGETS:%=container-run/%}:
-	$(MAKE) container-run COMMAND=${@:container-run/%=%}
-
-# CONTAINER STEPS - CLEAN
+# PUSH CONTAINER IMAGE
 # ==============================================================================
-PHONY+=container-run/clean
-container-run/clean:
-	$(MAKE) container-run COMMAND=${@:container-run/%=%}
-
-# GENERAL CONTAINER COMMAND
-# ==============================================================================
-PHONY+=container-run
-container-run:
-	${CONTAINER_RUNTIME} run \
-		--rm \
-		--volume ${PWD}:/workspace \
-		${BUILD_IMAGE_FULL} \
-			make ${COMMAND} \
-				VERSION=${VERSION} \
-				GOPROXY=${GOPROXY} \
-				GOPRIVATE=${GOPRIVATE} \
+PHONY+=container-image/push
+container-image/push:
+	echo ${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_PASSWORD} | ${CONTAINER_RUNTIME} login ${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_NAME} --username ${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_REGISTRY_USER} --password-stdin
+	${CONTAINER_RUNTIME} push ${DOCKERHUB_DESCRIPTION_UPDATER_IMAGE_FULLY_QUALIFIED}
 
 # PHONY
 # ==============================================================================
+# Declare the contents of the PHONY variable as phony.  We keep that information
+# in a variable so we can use it in if_changed.
 .PHONY: ${PHONY}

README.md

@@ -1,8 +1,5 @@
 # docker hub description updater
 
-[![Build Status](https://travis-ci.com/volker-raschek/docker-hub-description-updater.svg?branch=master)](https://travis-ci.com/volker-raschek/docker-hub-description-updater)
-[![Go Report Card](https://goreportcard.com/badge/github.com/volker-raschek/docker-hub-description-updater)](https://goreportcard.com/report/github.com/volker-raschek/docker-hub-description-updater)
-[![GoDoc Reference](https://godoc.org/github.com/volker-raschek/docker-hub-description-updater?status.svg)](http://godoc.org/github.com/volker-raschek/docker-hub-description-updater)
 [![Docker Pulls](https://img.shields.io/docker/pulls/volkerraschek/dhdu)](https://hub.docker.com/r/volkerraschek/dhdu)
 
 By specifying the login data for [hub.docker.com](https://hub.docker.com) you
@@ -10,8 +7,6 @@ can update the short and long description of a docker repository.
 
 ## Usage
 
-Test
-
 The examples below describe two ways to update the full description of the
 docker hub repository. First by the binary and second by a container based way.
 

cmd/root.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 
@@ -19,7 +18,7 @@ var (
 )
 
 // Execute a
-func Execute(version string) {
+func Execute(version string) error {
 	rootCmd := &cobra.Command{
 		Use:     "dhdu",
 		Short:   "docker hub description updater (dhdu)",
@@ -31,7 +30,7 @@ func Execute(version string) {
 	rootCmd.Flags().StringVarP(&dockerHubPassword, "password", "p", "", "Docker Hub Password")
 	rootCmd.Flags().StringVarP(&dockerHubRepository, "repository", "r", "", "Docker Hub Repository")
 	rootCmd.Flags().StringVarP(&dockerHubUser, "username", "u", "", "Docker Hub Username")
-	rootCmd.Execute()
+	return rootCmd.Execute()
 }
 
 func runE(cmd *cobra.Command, args []string) error {
@@ -39,29 +38,30 @@ func runE(cmd *cobra.Command, args []string) error {
 	file := args[0]
 
 	if len(dockerHubUser) <= 0 {
-		return fmt.Errorf("No user defined over flags")
+		return fmt.Errorf("no user defined over flags")
 	}
 
 	if len(dockerHubPassword) <= 0 {
-		return fmt.Errorf("No password defined over flags")
+		return fmt.Errorf("no password defined over flags")
 	}
 
 	if len(dockerHubNamespace) <= 0 {
-		log.Printf("No namespace defined over flags: Use docker username %v instead", dockerHubUser)
+		log.Printf("no namespace defined over flags: Use docker username %v instead", dockerHubUser)
 		dockerHubNamespace = dockerHubUser
 	}
 
 	if len(dockerHubRepository) <= 0 {
-		return fmt.Errorf("No repository defined over flags")
+		return fmt.Errorf("nNo repository defined over flags")
 	}
 
 	if _, err := os.Stat(file); os.IsNotExist(err) && len(file) <= 0 {
-		return fmt.Errorf("Can not find file: %v", file)
+		return fmt.Errorf("can not find file: %v", file)
 	}
 
-	f, err := ioutil.ReadFile(file)
+	// #nosec G304
+	f, err := os.ReadFile(file)
 	if err != nil {
-		return fmt.Errorf("Can not read file %v: %v", file, err)
+		return fmt.Errorf("can not read file %v: %v", file, err)
 	}
 	fullDescription := string(f)
 

go.mod

@@ -1,12 +1,10 @@
 module github.com/volker-raschek/docker-hub-description-updater
 
-go 1.13
+go 1.24
+
+require github.com/spf13/cobra v1.10.2
 
 require (
-	github.com/Masterminds/semver v1.5.0
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/go-flucky/flucky v0.0.0-20190714170626-0dd156f480be
-	github.com/spf13/cobra v0.0.3
-	github.com/stretchr/testify v1.4.0
-	github.com/volker-raschek/go-logger v0.0.0-20190924133618-4a42099e655f
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.9 // indirect
 )

go.sum

@@ -1,38 +1,10 @@
-github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww=
-github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y=
-github.com/d2r2/go-bsbmp v0.0.0-20190515110334-3b4b3aea8375/go.mod h1:3iz1WHlYJU9b4NJei+Q8G7DN3K05arcCMlOQ+qNCDjo=
-github.com/d2r2/go-i2c v0.0.0-20181113114621-14f8dd4e89ce/go.mod h1:AwxDPnsgIpy47jbGXZHA9Rv7pDkOJvQbezPuK1Y+nNk=
-github.com/d2r2/go-logger v0.0.0-20181221090742-9998a510495e/go.mod h1:oA+9PUt8F1aKJ6o4YU1T120i7sgo1T6/1LWEEBy0BSs=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/go-flucky/flucky v0.0.0-20190714170626-0dd156f480be h1:jCs/SAXdXUA0aqvEVH0wyeGpJzYOZ1XC9Kpm5anSY5E=
-github.com/go-flucky/flucky v0.0.0-20190714170626-0dd156f480be/go.mod h1:WNT729lCsTFhT6Vyvg6cG8aHV1t6p+DsA8l4omOuaos=
-github.com/go-flucky/go-dht v0.1.1/go.mod h1:Yk/cct+/u+eCS7pB/kc0tc7MrVXdFI4W15MJCj5FRUc=
-github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
-github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
-github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
-github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
-github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
-github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0=
-github.com/spf13/cobra v0.0.3 h1:ZlrZ4XsMRm04Fr5pSFxBgfND2EBVa1nLpiy1stUsX/8=
-github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ=
-github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
-github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
-github.com/stianeikeland/go-rpio v4.2.0+incompatible/go.mod h1:Sh81rdJwD96E2wja2Gd7rrKM+XZ9LrwvN2w4IXrqLR8=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
-github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
-github.com/volker-raschek/go-logger v0.0.0-20190924133618-4a42099e655f h1:e14Zt+f1EQkiwAorEkMO97S/bTUcoVLZAvgAR8yy/yc=
-github.com/volker-raschek/go-logger v0.0.0-20190924133618-4a42099e655f/go.mod h1:V4TEAy1Kx45GPlB2VvS5mVpNfSksNDDuEgk7wm7cd0k=
+github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
+github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
+github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
+github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
-periph.io/x/periph v3.4.0+incompatible/go.mod h1:EWr+FCIU2dBWz5/wSWeiIUJTriYv9v2j2ENBmgYyy7Y=

main.go

@@ -9,5 +9,5 @@ var (
 )
 
 func main() {
-	cmd.Execute(version)
+	_ = cmd.Execute(version)
 }

pkg/hub/errors.go

@@ -3,13 +3,11 @@ package hub
 import "errors"
 
 var (
-	errorFailedToCreateRequest    = errors.New("Failed to create http request")
-	errorFailedToParseJSON        = errors.New("Failed to parse json")
-	errorFailedToParseURL         = errors.New("Failed to parse url")
-	errorFailedToSendRequest      = errors.New("Failed to send http request")
-	errorNoUserDefined            = errors.New("No User defined")
-	errorNoPasswordDefined        = errors.New("No Password defined")
-	errorNoNamespaceDefined       = errors.New("No Namespace defined")
-	errorNoRepositoryDefined      = errors.New("No Repository defined")
-	errorUnexpectedHTTPStatuscode = errors.New("Unexpected HTTP-Statuscode")
+	errFailedToCreateRequest    = errors.New("failed to create http request")
+	errFailedToParseJSON        = errors.New("failed to parse json")
+	errFailedToParseURL         = errors.New("failed to parse url")
+	errFailedToSendRequest      = errors.New("failed to send http request")
+	errNoNamespaceDefined       = errors.New("no Namespace defined")
+	errNoRepositoryDefined      = errors.New("no Repository defined")
+	errUnexpectedHTTPStatuscode = errors.New("unexpected HTTP-Statuscode")
 )

pkg/hub/hub.go

@@ -25,22 +25,22 @@ type Hub struct {
 func (h *Hub) GetRepository(namespace string, name string) (*types.Repository, error) {
 
 	if len(namespace) <= 0 {
-		return nil, errorNoNamespaceDefined
+		return nil, errNoNamespaceDefined
 	}
 
 	if len(name) <= 0 {
-		return nil, errorNoRepositoryDefined
+		return nil, errNoRepositoryDefined
 	}
 
 	rawURL := fmt.Sprintf("%v/repositories/%v/%v", dockerHubAPI, namespace, name)
 	url, err := url.Parse(rawURL)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToParseURL, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToParseURL, err)
 	}
 
 	req, err := http.NewRequest(http.MethodGet, url.String(), nil)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
 	}
 
 	if h.token == nil {
@@ -54,18 +54,18 @@ func (h *Hub) GetRepository(namespace string, name string) (*types.Repository, e
 
 	resp, err := h.client.Do(req)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToSendRequest, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToSendRequest, err)
 	}
-	defer resp.Body.Close()
+	defer func() { _ = resp.Body.Close() }()
 
 	if resp.StatusCode != http.StatusOK {
-		return nil, fmt.Errorf("%v: expect %v, received %v", errorUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
+		return nil, fmt.Errorf("%v: expect %v, received %v", errUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
 	}
 
 	repository := new(types.Repository)
 	jsonDecoder := json.NewDecoder(resp.Body)
 	if err := jsonDecoder.Decode(repository); err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
 	}
 
 	return repository, nil
@@ -75,30 +75,30 @@ func (h *Hub) getToken() (*types.Token, error) {
 	loginBuffer := new(bytes.Buffer)
 	jsonEncoder := json.NewEncoder(loginBuffer)
 	if err := jsonEncoder.Encode(h.credentials); err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
 	}
 
 	rawURL := fmt.Sprintf("%v/users/login/", dockerHubAPI)
 	req, err := http.NewRequest(http.MethodPost, rawURL, loginBuffer)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
 	}
 	req.Header.Add("Content-Type", "application/json")
 
 	resp, err := h.client.Do(req)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
 	}
-	defer resp.Body.Close()
+	defer func() { _ = resp.Body.Close() }()
 
 	if resp.StatusCode != http.StatusOK {
-		return nil, fmt.Errorf("%v: expect %v, received %v", errorUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
+		return nil, fmt.Errorf("%v: expect %v, received %v", errUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
 	}
 
 	token := new(types.Token)
 	jsonDecoder := json.NewDecoder(resp.Body)
 	if err := jsonDecoder.Decode(token); err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
 	}
 
 	return token, nil
@@ -108,11 +108,11 @@ func (h *Hub) getToken() (*types.Token, error) {
 func (h *Hub) PatchRepository(repository *types.Repository) (*types.Repository, error) {
 
 	if len(repository.Namespcace) <= 0 {
-		return nil, errorNoNamespaceDefined
+		return nil, errNoNamespaceDefined
 	}
 
 	if len(repository.Name) <= 0 {
-		return nil, errorNoRepositoryDefined
+		return nil, errNoRepositoryDefined
 	}
 
 	if h.token == nil {
@@ -127,7 +127,7 @@ func (h *Hub) PatchRepository(repository *types.Repository) (*types.Repository,
 	rawURL := fmt.Sprintf("%v/repositories/%v/%v", dockerHubAPI, repository.Namespcace, repository.Name)
 	patchURL, err := url.Parse(rawURL)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToParseURL, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToParseURL, err)
 	}
 
 	data := &url.Values{}
@@ -136,24 +136,24 @@ func (h *Hub) PatchRepository(repository *types.Repository) (*types.Repository,
 
 	req, err := http.NewRequest(http.MethodPatch, patchURL.String(), nil)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
 	}
 	req.Header.Set("Authorization", fmt.Sprintf("JWT %v", h.token.Token))
 
 	resp, err := h.client.Do(req)
 	if err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToCreateRequest, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToCreateRequest, err)
 	}
-	defer resp.Body.Close()
+	defer func() { _ = resp.Body.Close() }()
 
 	if resp.StatusCode != http.StatusOK {
-		return nil, fmt.Errorf("%v: expect %v, received %v", errorUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
+		return nil, fmt.Errorf("%v: expect %v, received %v", errUnexpectedHTTPStatuscode, http.StatusOK, resp.StatusCode)
 	}
 
 	patchedRepository := new(types.Repository)
 	jsonDecoder := json.NewDecoder(resp.Body)
 	if err := jsonDecoder.Decode(h.token); err != nil {
-		return nil, fmt.Errorf("%v: %v", errorFailedToParseJSON, err)
+		return nil, fmt.Errorf("%v: %v", errFailedToParseJSON, err)
 	}
 
 	return patchedRepository, nil

pkg/hub/hub_test.go

@@ -1,54 +0,0 @@
-package hub
-
-import (
-	"os"
-	"testing"
-
-	"github.com/stretchr/testify/require"
-	"github.com/volker-raschek/docker-hub-description-updater/pkg/types"
-)
-
-func TestPatchRepository(t *testing.T) {
-
-	dockerHubUser := os.Getenv("REGISTRY_USER")
-	if len(dockerHubUser) <= 0 {
-		t.Fatalf("Environment variable REGISTRY_USER is empty")
-	}
-
-	dockerHubPassword := os.Getenv("REGISTRY_PASSWORD")
-	if len(dockerHubPassword) <= 0 {
-		t.Fatalf("Environment variable REGISTRY_PASSWORD is empty")
-	}
-
-	dockerHubNamespace := os.Getenv("REGISTRY_NAMESPACE")
-	if len(dockerHubNamespace) <= 0 {
-		t.Fatalf("Environment variable REGISTRY_NAMESPACE is empty")
-	}
-
-	dockerHubRepository := os.Getenv("CONTAINER_IMAGE_NAME")
-	if len(dockerHubRepository) <= 0 {
-		t.Fatalf("Environment variable CONTAINER_IMAGE_NAME is empty")
-	}
-
-	loginCredentials := &types.LoginCredentials{
-		User:     dockerHubUser,
-		Password: dockerHubPassword,
-	}
-
-	h := New(loginCredentials)
-
-	require := require.New(t)
-
-	readme, err := Asset("README.md")
-	require.NoError(err)
-
-	currentRepository, err := h.GetRepository(dockerHubNamespace, dockerHubRepository)
-	require.NoError(err)
-
-	expectedRepository := *currentRepository
-	expectedRepository.FullDescription = string(readme)
-
-	actualRepository, err := h.PatchRepository(&expectedRepository)
-	require.NoError(err)
-	require.EqualValues(&expectedRepository.FullDescription, actualRepository.FullDescription, "Full description not equal")
-}

renovate.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>volker.raschek/renovate-config:default#master",
+    "local>volker.raschek/renovate-config:container#master",
+    "local>volker.raschek/renovate-config:actions#master",
+    "local>volker.raschek/renovate-config:golang#master",
+    "local>volker.raschek/renovate-config:regexp#master"
+  ]
+}