feat: add publish suffix, swap to uv and update ci (#6)

Author: ALameLlama

.github/workflows/docker-publish.yml

@@ -9,18 +9,58 @@ jobs:
     name: Docker Image 🐳
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout code  ✍️
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get latest tag 🤔
+        id: get_tag
+        run: |
+          git fetch --tags
+          TAG=$(git describe --tags --abbrev=0)
+          # Extract version without v prefix
+          VERSION=${TAG#v}
+
+          echo "TAG=${TAG}" >> $GITHUB_ENV
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+          echo "MAJOR=$(echo $VERSION | cut -d. -f1)" >> $GITHUB_ENV
+          echo "MINOR=$(echo $VERSION | cut -d. -f2)" >> $GITHUB_ENV
+          echo "PATCH=$(echo $VERSION | cut -d. -f3)" >> $GITHUB_ENV
+
+          echo "Found tag: ${TAG}"
+          echo "Version: ${VERSION}"
+
+          # Check out the tagged commit
+          git checkout ${TAG}
+
       - name: Set up QEMU 🔨
         uses: docker/setup-qemu-action@v3
+
       - name: Set up Docker Buildx 🔧
         uses: docker/setup-buildx-action@v3
+
       - name: Login to Docker Hub 🔒
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Build distribution 📦
-        uses: docker/build-push-action@v5
+
+      - name: Set up Docker tags 🤔
+        id: docker_tags
+        run: |
+          TAGS="alamellama/certbot-dns-synergy-wholesale:latest"
+          TAGS="${TAGS},alamellama/certbot-dns-synergy-wholesale:${VERSION}"
+          TAGS="${TAGS},alamellama/certbot-dns-synergy-wholesale:${MAJOR}"
+          TAGS="${TAGS},alamellama/certbot-dns-synergy-wholesale:${MAJOR}.${MINOR}"
+          echo "TAGS=${TAGS}" >> $GITHUB_ENV
+          echo "Will push the following tags: ${TAGS}"
+
+      - name: Build distribution 📦
+        uses: docker/build-push-action@v6
         with:
+          context: ./
+          platforms: linux/amd64,linux/arm64
+          file: ./Dockerfile
           push: true
-          tags: alamellama/certbot-dns-synergy-wholesale:latest
+          tags: ${{ env.TAGS }}

.github/workflows/python-publish.yml

@@ -1,60 +1,28 @@
-name: Publish Python 🐍 distribution 📦 to PyPI
+name: "Publish 🚀"
 
 on:
   release:
-    types: [published]
+    types: ["published"]
 
 jobs:
-  build:
-    name: Build distribution 📦
+  run:
+    name: "Build and publish release 📦"
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.x"
-    - name: Install pypa/build
-      run: |
-        python3 -m pip install build --user
-    - name: Build a binary wheel and a source tarball
-      run: python3 -m build
-    - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
-      with:
-        name: python-package-distributions-${{ runner.os }}
-        path: dist/
+      - uses: actions/checkout@v4
 
-  merge:
-    name: Merge Artifacts 🛠️
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-    - name: Merge Artifacts
-      uses: actions/upload-artifact/merge@v4
-      with:
-        name: python-package-distributions
-        pattern: python-package-distributions-*
-        merge-multiple: true
+      - name: Install uv ⚡
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
 
-  publish-to-pypi:
-    name: Publish Python 🐍 distribution 📦 to PyPI
-    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
-    needs:
-      - merge
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/certbot-dns-synergy-wholesale
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
+      - name: Set up Python 🐍
+        run: uv python install 3.12
 
-    steps:
-    - name: Download All Artifacts
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Build 🛠️
+        run: uv build
+
+      - name: Publish 🚀
+        uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -1,5 +1,5 @@
-certbot-dns-synergy-wholesale
-==================
+# certbot-dns-synergy-wholesale
+
 <p align="center">
 <a href="https://github.com/ALameLlama/certbot-dns-synergy-wholesale/actions/workflows/docker-publish.yml"><img src="https://img.shields.io/github/actions/workflow/status/ALameLlama/certbot-dns-synergy-wholesale/.github/workflows/docker-publish.yml" alt="Build"></a>
 <a href="https://hub.docker.com/r/alamellama/certbot-dns-synergy-wholesale"><img alt="Docker Image Version" src="https://img.shields.io/docker/v/alamellama/certbot-dns-synergy-wholesale"></a>
@@ -8,10 +8,10 @@ certbot-dns-synergy-wholesale
 <a href="https://github.com/ALameLlama/certbot-dns-synergy-wholesale/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg" alt="License"></a>
 </p>
 
-A [Synergy Wholesale](https://synergywholesale.com) DNS plugin for [Cerbot](https://certbot.eff.org/) to authenticate and retrieve Lets Encrypt certificates. Automates the process of completing a `dns-01` challenge by creating, and subsequently removing, `TXT` records 
+A [Synergy Wholesale](https://synergywholesale.com) DNS plugin for [Cerbot](https://certbot.eff.org/) to authenticate and retrieve Lets Encrypt certificates. Automates the process of completing a `dns-01` challenge by creating, and subsequently removing, `TXT` records
+
+## Installation
 
-Installation
-------------
 ```
 # create a virtual environment, to avoid conflicts
 python3 -m venv /some/path
@@ -24,34 +24,31 @@ python3 -m venv /some/path
 /some/path/bin/certbot
 ```
 
-Named Arguments
----------------
+## Named Arguments
+
 To start using DNS authentication for Synergy Wholesale, pass the following arguments on certbot's command line:
 
-| Option                                  | Description                                                                           |
-|-----------------------------------------|---------------------------------------------------------------------------------------|
-| `--authenticator dns-synergy-wholesale`           | select the authenticator plugin (Required)                                            |
-| `--dns-synergy-wholesale-credentials FILE`        | credentials INI file. (Required)                                              |
+| Option                                     | Description                                |
+| ------------------------------------------ | ------------------------------------------ |
+| `--authenticator dns-synergy-wholesale`    | select the authenticator plugin (Required) |
+| `--dns-synergy-wholesale-credentials FILE` | credentials INI file. (Required)           |
 
-Credentials
------------
+## Credentials
 
 Use of this plugin requires a configuration file containing API credentials, obtained from your [manage.synergywholesale.com](https://manage.synergywholesale.com/home/resellers/api).
 
 **Warning:** You must whitelist the IP address from where certbot will run, Otherwise you'll run into API errors.
 
 Remember this file will need to have 600 permissions.
 
-
 An example `credentials.ini` file:
 
-``` {.sourceCode .ini}
+```{.sourceCode .ini}
 dns_synergy_wholesale_reseller_id = 1
 dns_synergy_wholesale_api_key = abc123
 ```
 
-Examples
---------
+## Examples
 
 To acquire a single certificate for both `example.com` and `*.example.com`
 
@@ -63,9 +60,7 @@ To acquire a single certificate for both `example.com` and `*.example.com`
 
 You can also add addtional paramaters such as `--keep-until-expiring --non-interactive --expand` for automation. More information [here](https://eff-certbot.readthedocs.io/en/stable/using.html#certbot-command-line-options)
 
-
-Docker
-------
+## Docker
 
 You can build a docker image from source using the included `Dockerfile` or pull the latest version directly from Docker Hub:
 
@@ -86,3 +81,17 @@ Once that's finished, the application can be run as follows:
         -d example.com -d '*.example.com'
 
 You may want to change the volumes `/var/lib/letsencrypt` and `/etc/letsencrypt` to local directories where the certificates and configuration should be stored.
+
+## Dev Setup
+
+```
+# Create and activate a virtual environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Install uv (if not already installed)
+pip install uv
+
+# Install all dependencies using the lockfile
+uv sync --dev
+```

certbot_dns_synergy_wholesale.py

@@ -4,6 +4,7 @@
 from certbot import errors
 from certbot.plugins import dns_common
 from certbot.plugins.dns_common import CredentialsConfiguration
+from publicsuffixlist import PublicSuffixList
 from zeep import Client, Settings
 
 logger = logging.getLogger(__name__)
@@ -114,19 +115,20 @@ def _parse_domain(self, full_domain):
       Returns tuple of (domain, subdomain)
       """
 
-      # extract the parent domain
-      root_domain = '.'.join(full_domain.split(sep='.')[-2:])
+      # extract the root domain
+      psl = PublicSuffixList()
+      root_domain =psl.privatesuffix(full_domain)
+
       # And extract the subdomain
-      subdomain = full_domain.removesuffix(parentdomain).removesuffix(".")
+      subdomain = full_domain.removesuffix(root_domain).removesuffix(".")
 
-      return parentdomain, subdomain
+      return root_domain, subdomain
 
     def add_txt_record(self, domain, validation_name, validation) -> Union[str, None]:
-
-        domain, subdomain = self.domainsplitter(validation_name)
+        root_domain, _ = self._parse_domain(validation_name)
 
         request_data = {
-            "domainName": domain,
+            "domainName": root_domain,
             "recordName": validation_name,
             "recordType": "TXT",
             "recordContent": validation,
@@ -141,17 +143,16 @@ def add_txt_record(self, domain, validation_name, validation) -> Union[str, None
         return None if response["status"] == "OK" else response["errorMessage"]
 
     def del_txt_record(self, domain, validation) -> Union[str, None]:
+        root_domain, _ = self._parse_domain(domain)
 
-        domain, subdomain = self.domainsplitter(domain)
-
-        id = self.find_txt_record_id(domain, validation)
+        id = self._find_txt_record_id(root_domain, validation)
 
         # If we failed to get id, return early
         if id is None:
             return "Failed to find record"
 
         request_data = {
-            "domainName": domain,
+            "domainName": root_domain,
             "recordID": id,
         }
 
@@ -160,7 +161,7 @@ def del_txt_record(self, domain, validation) -> Union[str, None]:
 
         return None if response["status"] == "OK" else response["errorMessage"]
 
-    def find_txt_record_id(self, domain, validation) -> Union[str, None]:
+    def _find_txt_record_id(self, domain, validation) -> Union[str, None]:
         request_data = {"domainName": domain}
 
         request_data.update(self.base_request)