chore(*): archive the add-on, fixes #29

.gitattributes

@@ -0,0 +1,5 @@
+# Exclude files from releases/tarballs
+tests/ export-ignore
+.github/ export-ignore
+.gitattributes export-ignore
+.githooks/ export-ignore

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,15 +1,19 @@
 ## The Issue
 
-- #<issue number>
+- Fixes #REPLACE_ME_WITH_RELATED_ISSUE_NUMBER
 
 <!-- Provide a brief description of the issue. -->
 
 ## How This PR Solves The Issue
 
+<!-- Describe the key change(s) in this PR that address the issue above. -->
+
 ## Manual Testing Instructions
 
+<!-- If this PR changes logic, consider adding additional steps or context to the instructions below. -->
+
 ```bash
-ddev add-on get https://github.com/<user>/<repo>/tarball/<branch>
+ddev add-on get https://github.com/ddev/ddev-redis-commander/tarball/refs/pull/REPLACE_ME_WITH_THIS_PR_NUMBER/head
 ddev restart
 ```
 

.github/workflows/release.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Check version ${{ env.VERSION_NUMBER }} consistency in files
         # Check CHANGELOG.md
         run: |
-          
+
           # Check top ## [VERSION_NUMBER](GITHUB_URL/releases/tag/VERSION_NUMBER) - yyyy-mm-dd in CHANGELOG.md
           CURRENT_DATE=$(date +'%Y-%m-%d')
           echo $CURRENT_DATE
@@ -49,7 +49,7 @@ jobs:
               echo "CHANGELOG VERSION KO"
               exit 1
           fi
-          
+
           # Check top [_Compare with previous release_](GITHUB_URL/compare/LAST_TAG...VERSION_NUMBER) in CHANGELOG.md
           COMPARISON=$(grep -oP "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/compare/\K(.*)$" CHANGELOG.md | head -1)
           LAST_TAG=$(curl -Ls -o /dev/null -w %{url_effective} $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/latest | grep -oP "\/tag\/\K(.*)$")

.github/workflows/tests.yml

@@ -1,10 +1,12 @@
 name: tests
 on:
   pull_request:
+    paths-ignore:
+      - "**.md"
   push:
     branches: [ main ]
     paths-ignore:
-      - '**.md'
+      - "**.md"
 
   schedule:
     - cron: '06 07 * * *'

README.md

@@ -3,7 +3,17 @@
 [![last commit](https://img.shields.io/github/last-commit/ddev/ddev-redis-commander)](https://github.com/ddev/ddev-redis-commander/commits)
 [![release](https://img.shields.io/github/v/release/ddev/ddev-redis-commander)](https://github.com/ddev/ddev-redis-commander/releases/latest)
 
-## Redis Commander
+## Redis Commander (archived)
+
+This add-on has been archived and is no longer actively maintained.
+
+Use the [ddev/ddev-redis-insight](https://github.com/ddev/ddev-redis-insight) add-on instead, which provides a more modern and feature-rich interface for managing Redis databases:
+
+```bash
+ddev add-on remove ddev/ddev-redis-commander
+ddev add-on get ddev/ddev-redis-insight
+ddev restart
+```
 
 ## Overview
 

install.yaml

@@ -8,7 +8,7 @@ project_files:
   - docker-compose.redis-commander_norouter.yaml
   - commands/host/redis-commander
 
-ddev_version_constraint: '>= v1.24.3'
+ddev_version_constraint: '>= v1.24.10'
 
 post_install_actions:
   - |
@@ -23,6 +23,8 @@ post_install_actions:
     fi
   - |
     echo "You can now use 'ddev redis-commander' to launch Redis Commander UI"
+    echo ""
+    echo "⚠️ This add-on is no longer maintained, use https://github.com/ddev/ddev-redis-insight instead."
 
 removal_actions:
   - |

tests/test.bats

@@ -75,8 +75,14 @@ health_checks() {
 
 teardown() {
   set -eu -o pipefail
-  ddev delete -Oy ${PROJNAME} >/dev/null 2>&1
-  [ "${TESTDIR}" != "" ] && rm -rf ${TESTDIR}
+  ddev delete -Oy "${PROJNAME}" >/dev/null 2>&1
+  # Persist TESTDIR if running inside GitHub Actions. Useful for uploading test result artifacts
+  # See example at https://github.com/ddev/github-action-add-on-test#preserving-artifacts
+  if [ -n "${GITHUB_ENV:-}" ]; then
+    [ -e "${GITHUB_ENV:-}" ] && echo "TESTDIR=${HOME}/tmp/${PROJNAME}" >> "${GITHUB_ENV}"
+  else
+    [ "${TESTDIR}" != "" ] && rm -rf "${TESTDIR}"
+  fi
 }
 
 @test "install from directory" {