prepare next release v0.3.0 (#18)

### 📖 Summary

- update changelog

### 📑 Test Plan

✅ CI pipeline tests (Default)

### 💬 Details

_No response_

### 📚 Additional Notes

_No response_

Reviewed-on: #18

.editorconfig

@@ -1,14 +1,14 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-
-[*.go]
-indent_style = tab
-indent_size = 4
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+
+[*.go]
+indent_style = tab
+indent_size = 4

.hadolint.yml

@@ -0,0 +1,3 @@
+ignored:
+  - DL3018 # pin versions in Dockerfile
+  - DL3013 # pin pip versions in Dockerfile

.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "default": true,
+  "MD013": {
+    "line_length": 116,
+    "code_block_line_length": 116,
+    "tables": false
+  }
+}

.vscode/dictionaries/project-words.txt

@@ -1 +1,3 @@
+gitea
+Gitea
 tbd

.vscode/extensions.json

@@ -5,6 +5,7 @@
     "streetsidesoftware.code-spell-checker",
     "streetsidesoftware.code-spell-checker-german",
     "bierner.emojisense",
-    "ryanluker.vscode-coverage-gutters"
+    "ryanluker.vscode-coverage-gutters",
+    "davidanson.vscode-markdownlint"
   ]
 }

.vscode/settings.json

@@ -9,20 +9,6 @@
   "editor.rulers": [
     116
   ],
-  // powershell general
-  "powershell.startAutomatically": true,
-  "powershell.enableProfileLoading": true,
-  "powershell.scriptAnalysis.enable": true,
-  // powershell code Formatting
-  "powershell.codeFormatting.openBraceOnSameLine": true,
-  "powershell.codeFormatting.newLineAfterOpenBrace": true,
-  "powershell.codeFormatting.newLineAfterCloseBrace": true,
-  "powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
-  "powershell.codeFormatting.whitespaceBeforeOpenParen": true,
-  "powershell.codeFormatting.whitespaceAroundOperator": true,
-  "powershell.codeFormatting.whitespaceAfterSeparator": true,
-  "powershell.codeFormatting.ignoreOneLineBlock": true,
-  "powershell.codeFormatting.alignPropertyValuePairs": true,
   // cSpell settings for custom dictionary
   "cSpell.enabled": true,
   "cSpell.caseSensitive": false,
@@ -67,5 +53,10 @@
       "addWords": true
     },
     "custom": true
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
   }
 }

.vscode/tasks.json

@@ -6,7 +6,8 @@
         "type": "shell",
         "command": [
           "mv 'CHANGELOG.md' 'CHANGELOG.back' &&",
-          "changelog -m '${input:Milestone}' --token '${input:GiteaToken}' -c .changelog.yml generate > CHANGELOG.md &&",
+          "echo '<!-- markdownlint-disable MD041 -->' > CHANGELOG.md &&",
+          "changelog -m '${input:Milestone}' --token '${input:GiteaToken}' -c .changelog.yml generate >> CHANGELOG.md &&",
           "echo '' >> CHANGELOG.md &&",
           "cat CHANGELOG.back >> CHANGELOG.md &&",
           "rm CHANGELOG.back"

.woodpecker/ci.yml

@@ -5,7 +5,7 @@ when:
       - ${CI_REPO_DEFAULT_BRANCH}
 
 variables:
-  - &build_plugin 'woodpeckerci/plugin-docker-buildx:3.2.1'
+  - &build_plugin 'woodpeckerci/plugin-docker-buildx:4.2.0'
   # deployment targets
   # TODO: Disabled docker hub target until first release is ready / Rate Limits
   - &publish_repos 'ocram85/plugin-gitea-package,gitea.ocram85.com/plugins/gitea-package'
@@ -26,6 +26,28 @@ variables:
         from_secret: gitea_passwd
 
 steps:
+  lint-dockerfile:
+    image: hadolint/hadolint:v2.12.1-beta-alpine
+    commands:
+      #- cat Dockerfile
+      #- hadolint --verbose --ignore DL3003 --ignore DL3018 Dockerfile
+      - hadolint --ignore DL3003 --ignore DL3018 Dockerfile
+    #when:
+    #  path: "Dockerfile"
+
+  lint-markdown:
+    image: davidanson/markdownlint-cli2:v0.14.0
+    commands:
+      - "markdownlint-cli2 *.{md,markdown}"
+    when:
+      path: "*.{md,markdown}"
+
+  lint-editorconfig:
+    depends_on: []
+    image: docker.io/mstruebing/editorconfig-checker:v3.0.3
+    when:
+      event: pull_request
+
   test:
     image: *build_plugin
     settings:

.woodpecker/test-image.yml

@@ -4,44 +4,67 @@ when:
     branch:
       - ${CI_REPO_DEFAULT_BRANCH}
 
+
+variables:
+  - &build_plugin 'gitea.ocram85.com/plugins/gitea-package:next'
+  - &default_settings
+      user:
+        from_secret: gitea_user
+      password:
+        from_secret: gitea_passwd
+      owner: "plugins"
+      package_name: "dummy_package"
+      package_version: "0.1.0"
+      file_source: "./README.md"
+      file_name: "readme.md"
+      #update: "true"
+
 depends_on:
   - "ci"
 
 steps:
-  next:
-    image: gitea.ocram85.com/plugins/gitea-package:next
+  default:
+    image: *build_plugin
     pull: true
     secrets: [ gitea_user, gitea_passwd]
     settings:
-      user:
-        from_secret: gitea_user
-      password:
-        from_secret: gitea_passwd
+      <<: *default_settings
+      update: "true"
+    when:
+      event: pull_request
+      branch: ${CI_REPO_DEFAULT_BRANCH}
+
+  debug-out:
+    image: *build_plugin
+    pull: true
+    secrets: [ gitea_user, gitea_passwd]
+    settings:
+      <<: *default_settings
+      update: "true"
       debug: "true"
-      owner: "plugins"
-      package_name: "dummy_package"
-      package_version: "0.1.0"
-      file_source: "./README.md"
-      file_name: "readme.md"
-      update: "true"
     when:
       event: pull_request
       branch: ${CI_REPO_DEFAULT_BRANCH}
-  next-nodebug:
-    image: gitea.ocram85.com/plugins/gitea-package:next
+
+  no-update:
+    image: *build_plugin
     pull: true
+    failure: ignore
     secrets: [ gitea_user, gitea_passwd]
     settings:
-      user:
-        from_secret: gitea_user
-      password:
-        from_secret: gitea_passwd
-      owner: "plugins"
-      package_name: "dummy_package"
-      package_version: "0.1.0"
-      file_source: "./README.md"
-      file_name: "readme.md"
-      update: "true"
+      <<: *default_settings
+      debug: "true"
+    when:
+      event: pull_request
+      branch: ${CI_REPO_DEFAULT_BRANCH}
+
+  no-update-debug:
+    image: *build_plugin
+    pull: true
+    failure: ignore
+    secrets: [ gitea_user, gitea_passwd]
+    settings:
+      <<: *default_settings
     when:
       event: pull_request
       branch: ${CI_REPO_DEFAULT_BRANCH}

CHANGELOG.md

@@ -1,3 +1,29 @@
+<!-- markdownlint-disable MD041 -->
+## [v0.3.0](https://gitea.ocram85.com/plugins/gitea-package/releases/tag/v0.3.0) - 2024-09-09
+
+* 🤖 DEPENDENCIES
+  * Chore(deps): update davidanson/markdownlint-cli2 docker tag to v0.14.0 (#17)
+  * Chore(deps): update curlimages/curl docker tag to v8.9.1 (#16)
+  * Chore(deps): update woodpeckerci/plugin-docker-buildx docker tag to v4.2.0 (#15)
+
+<!-- markdownlint-disable MD041 -->
+## [v0.2.0](https://gitea.ocram85.com/plugins/gitea-package/releases/tag/v0.2.0) - 2024-07-09
+
+* 🤖 DEPENDENCIES
+  * Chore(deps): update docker.io/mstruebing/editorconfig-checker docker tag to v3.0.3 (#13)
+  * Chore(deps): update curlimages/curl docker tag to v8.8.0 (#12)
+
+<!-- markdownlint-disable MD041 -->
+## [v0.1.1](https://gitea.ocram85.com/plugins/gitea-package/releases/tag/v0.1.1) - 2024-05-17
+
+* 🛠️ ENHANCEMENTS
+  * Extend text output (#10)
+* 📦 BUILD
+  * Add linter + renovate (#6)
+* 🤖 DEPENDENCIES
+  * Chore(deps): update woodpeckerci/plugin-docker-buildx docker tag to v4 (#8)
+
+<!-- markdownlint-disable MD041 -->
 ## [v0.1.0](https://gitea.ocram85.com/plugins/gitea-package/releases/tag/v0.1.0) - 2024-05-14
 
 * 🐛 BUGFIXES
@@ -7,4 +33,3 @@
   * Migrate content (#1)
 * ⚙️ META
   * Update Gitea meta files (#2)
-

Dockerfile

@@ -1,4 +1,4 @@
-FROM curlimages/curl:8.7.1
+FROM curlimages/curl:8.9.1
 LABEL org.opencontainers.image.authors="marco@ocram85.com"
 #ENV PLUGIN_OWNER
 #ENV PLUGIN_PACKAGE_NAME

README.md

@@ -1,6 +1,8 @@
+<!-- markdownlint-disable MD033 MD041 -->
+
 <p align="right">
-  <img src="http://forthebadge.com/images/badges/built-with-love.svg">
-  <img src="http://forthebadge.com/images/badges/for-you.svg">
+  <img src="http://forthebadge.com/images/badges/built-with-love.svg" alt="built-with-love">
+  <img src="http://forthebadge.com/images/badges/for-you.svg" alt="for-you">
 </p>
 
 <p align="center">

gitea-package.sh

@@ -26,13 +26,16 @@ sayW() {
   fi
 }
 
-showHelp() {
-  cat << HELP
-  🤖 gitea-package Woodpecker-CI Plugin
-
-  Syntax:
-HELP
-}
+# TODO: Disabled for now. No default help output needed if just running as
+# Woodpecker CI plugin.
+#
+#showHelp() {
+#  cat << HELP
+#  🤖 gitea-package Woodpecker-CI Plugin
+#
+#  Syntax:
+#HELP
+#}
 
 showENV() {
   env | sort
@@ -75,41 +78,41 @@ deleteArtifact() {
 }
 
 uploadArtifact() {
-  say "Testing if the artifact already exists in give package version..." "uploadArtifact"
+  say "Testing if the given artifact already exists in the package registry..." "uploadArtifact"
   fexist=$(testArtifact)
   if [ "$fexist" = "true" ]; then
     if [ -n "$PLUGIN_UPDATE" ]; then
-      sayW "Given file already exists. Updating package file..." "uploadArtifact"
+      sayW "🚧 Given file already exists. Removing remote file..." "uploadArtifact"
       deleteArtifact
     else
-      sayW "A file with the same name exist already in the package." "uploadArtifact"
+      sayW "🛑 File already exists in the package registry." "uploadArtifact"
       exit 1
     fi
   fi
-  say "Starting file upload..." "uploadArtifact"
+  say "Starting file upload... ($PLUGIN_FILE_SOURCE)" "uploadArtifact"
   cout=$(curl --silent --output /dev/null --write-out "%{http_code}" \
     --user "$PLUGIN_USER:$PLUGIN_PASSWORD" \
     --upload-file "$PLUGIN_FILE_SOURCE" \
     "$CI_FORGE_URL/api/packages/$PLUGIN_OWNER/generic/$PLUGIN_PACKAGE_NAME/$PLUGIN_PACKAGE_VERSION/$PLUGIN_FILE_NAME")
-  say "Curl output is: $cout" "uploadArtifact"
+  say "Curl http response code: $cout" "uploadArtifact"
 
   if [ "$cout" = "201" ]; then
-    say "Upload sucessfully finished." "uploadArtifact"
+    say "Upload sucessfully finished. ✅" "uploadArtifact"
     exit 0
   elif [ "$cout" = "400" ]; then
-    sayE "Upload failed! (Bad Request)" "uploadArtifact"
+    sayE "Upload failed! (Bad Request) 💣" "uploadArtifact"
     exit 1
   elif [ "$cout" = "409" ]; then
-    sayE "File already exists in package version!" "uploadArtifact"
+    sayE "File already exists in package version! 🛑" "uploadArtifact"
   else
-    sayE "Unknown upload response! ($cout)" "uploadArtifact"
+    sayE "Unknown upload response! ($cout) 💣" "uploadArtifact"
     exit 1
   fi
 }
 
 main() {
   if [ -n "$PLUGIN_DEBUG" ]; then
-    sayW "Debug mode enabled."
+    sayW "🐞 Debug mode enabled."
     showSettings
     #sayW "Available ENV vars:"
     #showENV

renovate.json

@@ -0,0 +1,12 @@
+{
+  "dependencyDashboard": true,
+  "docker": {
+    "enabled": true
+  },
+  "woodpecker": {
+    "enabled": true,
+    "fileMatch": [
+      "^.woodpecker\/.*.yml$"
+    ]
+  }
+}