Merge branch 'OctoPrint:gh-pages' into gh-pages

Author: NilsRo

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,50 @@
+<!--
+Thank you for your interest in registering a plugin on the official
+OctoPrint Plugin Repository!
+
+Before you continue, please ensure & check the following things (to check, turn '[ ]' into '[x]'):
+-->
+
+- [ ] You have read the ["Registering a new Plugin"](https://plugins.octoprint.org/help/registering/) guide.
+- [ ] You want to and are able to maintain the plugin you are registering, long-term.
+- [ ] You understand why the plugin you are registering works.
+- [ ] You have read and acknowledge the [Code of Conduct](https://octoprint.org/conduct/).
+
+<!--
+Please answer the following questions:
+-->
+
+#### What is the name of your plugin?
+
+<!-- put your answer after this line -->
+
+#### What does your plugin do?
+
+<!-- put your answer after this line -->
+
+#### Where can we find the source code of your plugin?
+
+<!-- put your answer after this line -->
+
+#### Was any kind of genAI (ChatGPT, Copilot etc) involved in creating this plugin?
+
+<!-- put your answer after this line -->
+
+#### Is your plugin commercial in nature?
+
+<!-- put your answer after this line -->
+
+#### Does your plugin rely on some cloud services?
+
+<!-- put your answer after this line -->
+
+<!--
+If you want to add anything else, you can do so here
+-->
+
+#### Further notes
+
+<!--
+If you are not actually registering a plugin but just want to make changes to one you already
+registered in the past, just delete this template and explain your PR yourself.
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -433,7 +433,11 @@ def out(line, prefix="", *args, **kwargs):
     out("Processing plugin {} at path {}".format(plugin_id, path))
 
     if incl_stats:
-        if "commercial" not in data.get("attributes", []):
+        attributes = data.get("attributes", [])
+        if attributes is None:
+            attributes = []
+
+        if "commercial" not in attributes:
             def build_stats(stats):
                 result = dict(
                     instances=stats.get("instances", 0),

.github/scripts/populate_additional_metadata.py

@@ -2,5 +2,6 @@ requests
 python-frontmatter
 colorama
 voluptuous
-click
+click!=8.2.0
 ruamel.yaml<0.18
+packaging

.github/scripts/requirements.txt

@@ -7,20 +7,25 @@
 import click
 import colorama
 import frontmatter
-import pkg_resources
+from packaging.specifiers import SpecifierSet
 from voluptuous import All, Any, Invalid, Length, Optional, Required, Schema, Url
 
 OCTOPRINT_PY3_SUPPORT = ("3.7", "3.8", "3.9", "3.10", "3.11", "3.12")
 
 NonEmptyString = All(str, Length(min=1))
 
+class ValidationError(ValueError):
+    def __init__(self, *args, error_messages=None):
+        super().__init__(*args)
+        self.error_messages = error_messages
+
 
 def to_requirement(compat, name="Foo"):
     if not any(
         compat.startswith(c) for c in ("<", "<=", "!=", "==", ">=", ">", "~=", "===")
     ):
         compat = ">={}".format(compat)
-    return pkg_resources.Requirement.parse(name + compat)
+    return SpecifierSet(compat)
 
 
 def Version(v):
@@ -88,7 +93,7 @@ def ImageLocation(v):
         Optional("disabled"): NonEmptyString,
         Optional("abandoned"): NonEmptyString,
         Optional("up_for_adoption"): Url(),
-        Optional("redirect_from"): NonEmptyString,
+        Optional("redirect_from"): Any(All([NonEmptyString]), NonEmptyString),
         Optional("attributes"): Any(list, None),
     }
 )
@@ -128,7 +133,7 @@ def check_url(url):
             # image url is a path
             image_path = os.path.abspath(os.path.join(src, url[1:]))
             if not os.path.exists(image_path):
-                raise Invalid(
+                raise ValidationError(
                     "image location '{}' doesn't exist on disk ({})".format(
                         url, image_path
                     )
@@ -144,7 +149,7 @@ def check_url(url):
     return []
 
 
-def validate_image_urls(data, path):
+def validate_internal_assets(data, path):
     warnings = []
 
     filename = os.path.basename(path)[:-3]
@@ -183,24 +188,50 @@ def validate_id_match(data, path):
     filename = os.path.basename(path)[:-3]
     if data["id"] != filename:
         return [
-            "id '{}' does not match file name '{}.md' @ data['id']".format(
+            "id '{}' does not match file name '{}.md', please rename the file @ data['id']".format(
                 data["id"], filename
             )
         ]
     return []
 
 
+def validate_asset_match(data, path):
+    errors = []
+
+    filename = os.path.basename(path)[:-3]
+
+    def check_url(loc, url):
+        if url.startswith("/assets/img/plugins/") and not url.startswith("/assets/img/plugins/{}".format(filename)):
+            folder = url.split("/")[4]
+            message = "asset folder of image '{}' does not match plugin identifier {}: {} @ {}".format(url, filename, folder, loc)
+            errors.append(message)
+
+    if "screenshots" in data:
+        count = 0
+        for entry in data["screenshots"]:
+            check_url("data['screenshots'][{}]['url']".format(count), entry["url"])
+            count += 1
+
+    if "featuredimage" in data:
+        check_url("data['featuredimage']", data["featuredimage"])
+
+    if errors:
+        raise ValidationError("plugin references assets in mismatched asset folder", error_messages=errors)
+
+    return []
+
+
 def validate_python_compatibility(data):
     warnings = []
 
     if "compatibility" in data and "python" in data["compatibility"]:
         requirement = to_requirement(data["compatibility"]["python"], name="Python")
         if all(map(lambda x: x not in requirement, OCTOPRINT_PY3_SUPPORT)):
-            raise ValueError(
+            raise ValidationError(
                 "python compatibility does not include Python 3 @ data['compatibility']['python']"
             )
     else:
-        raise ValueError("not flagged as Python 3 compatible @ data")
+        raise ValidationError("not flagged as Python 3 compatible @ data")
     return warnings
 
 
@@ -215,13 +246,13 @@ def validate_date_unchanged(data, path, src, sha, debug=False):
     try:
         output = subprocess.check_output(command, encoding="utf-8")
         if not output:
-            raise ValueError("could not read prior version")
+            raise ValidationError("could not read prior version")
     except subprocess.CalledProcessError:
         return
 
     old_metadata, old_content = frontmatter.parse(output)
     if data["date"] != old_metadata.get("date"):
-        raise ValueError(
+        raise ValidationError(
             "date must not be changed after initial registration @ data['date']"
         )
 
@@ -232,6 +263,7 @@ def validate(
     src,
     path,
     id_match=False,
+    asset_match=False,
     internal_assets=False,
     date_unchanged=False,
     screenshots_present=False,
@@ -250,8 +282,11 @@ def validate(
     if id_match:
         warnings += validate_id_match(metadata, path)
 
+    if asset_match:
+        warnings += validate_asset_match(metadata, path)
+
     if internal_assets:
-        warnings += validate_image_urls(metadata, path)
+        warnings += validate_internal_assets(metadata, path)
 
     if screenshots_present:
         warnings += validate_screenshots_present(metadata)
@@ -274,6 +309,7 @@ def validate(
 @click.option("--debug", is_flag=True)
 @click.option("--src", "src")
 @click.option("--check-id-match", "id_match", is_flag=True)
+@click.option("--check-asset-match", "asset_match", is_flag=True)
 @click.option("--check-internal-assets", "internal_assets", is_flag=True)
 @click.option(
     "--check-date-unchanged",
@@ -289,6 +325,7 @@ def main(
     debug=False,
     src=None,
     id_match=False,
+    asset_match=False,
     internal_assets=False,
     date_unchanged=None,
     screenshots_present=False,
@@ -321,6 +358,7 @@ def main(
                 src,
                 path,
                 id_match=id_match,
+                asset_match=asset_match,
                 internal_assets=internal_assets,
                 date_unchanged=date_unchanged,
                 screenshots_present=screenshots_present,
@@ -331,6 +369,13 @@ def main(
             print("{}: ".format(path), end="")
             print(colorama.Fore.RED + colorama.Style.BRIGHT + "FAIL")
 
+            if isinstance(exc, ValidationError) and exc.error_messages:
+                for error in exc.error_messages:
+                    if action_output:
+                        print("::error file={}::{}".format(path[len(src) + 1:], error))
+                    else:
+                        print("  " + error)
+
             if action_output:
                 print("::error file={}::{}".format(path[len(src) + 1 :], str(exc)))
             else:

.github/scripts/validate_front_matter.py

@@ -24,10 +24,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: 🐍 Set up Python 3.7
+      - name: 🐍 Set up Python 3.11
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7"
+          python-version: "3.11"
 
       - name: 🐍 Install requirements
         run: |
@@ -40,7 +40,7 @@ jobs:
 
       - name: 🕵️‍♂ Validate front matter
         run: |
-          python .github/scripts/validate_front_matter.py --action-output
+          python .github/scripts/validate_front_matter.py --check-id-match --check-asset-match --action-output
 
       - name: 🏗 Enrich front matter
         if: github.repository == 'OctoPrint/plugins.octoprint.org' && github.event_name != 'pull_request'
@@ -64,7 +64,7 @@ jobs:
       - name: 💎 Set up Ruby 3
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
+          ruby-version: '3.4'
           bundler-cache: true
 
       - name: 🔨 Build page
@@ -90,7 +90,7 @@ jobs:
           peterdavehello/jsonlint jsonlint -q /json/search.json
 
       - name: ⬆ Upload pages artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ./_site
 
@@ -123,4 +123,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

.github/workflows/publish-to-github-pages.yml

@@ -18,10 +18,10 @@ jobs:
           path: current
           ref: gh-pages
 
-      - name: 🐍 Set up Python 3.7
+      - name: 🐍 Set up Python 3.11
         uses: actions/setup-python@v4
         with:
-          python-version: "3.7"
+          python-version: "3.11"
 
       - name: 🐍 Install requirements
         run: |
@@ -36,12 +36,13 @@ jobs:
 
           while read modifier file; do
             if [[ $file == _plugins/* ]] && [[ $file == *.md ]]; then
+              args="--debug --check-internal-assets --check-id-match --check-asset-match --check-py3-compat --action-output"
               if [ "$modifier" == "M" ]; then
                 echo "MODIFIED: $file"
-                python ../current/.github/scripts/validate_front_matter.py "$file" --debug --check-date-unchanged=${{ github.event.pull_request.base.sha }} --action-output
+                python ../current/.github/scripts/validate_front_matter.py "$file" --check-date-unchanged=${{ github.event.pull_request.base.sha }} $args
               elif [ "$modifier" == "A" ]; then
                 echo "ADDED: $file"
-                python ../current/.github/scripts/validate_front_matter.py "$file" --debug --check-internal-assets --check-id-match --check-py3-compat --action-output
+                python ../current/.github/scripts/validate_front_matter.py "$file" $args
               fi
             fi
           done < <(git diff-tree --no-commit-id --name-status -r ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} | xargs -n2 )

.github/workflows/validate-pull-requests.yml

@@ -1,9 +1,10 @@
 source 'https://rubygems.org'
 gem 'github-pages', group: :jekyll_plugins
+
+# windows
 gem 'wdm', '>= 0.1.0' if Gem.win_platform?
 gem 'eventmachine', '1.2.7', git: 'git@github.com:eventmachine/eventmachine', tag: 'v1.2.7' if Gem.win_platform?
 
+# linting
 gem 'html-proofer'
 gem 'jsonlint'
-
-gem "webrick", "~> 1.7"