Refactor authentication inputs in action.yml and README.md

- Renamed 'registry-token' to 'registry-password' for clarity and consistency.
- Marked 'registry-token' as deprecated with a clear message to use 'registry-password' instead.
- Updated README examples to reflect the new input naming and deprecation notice.

Author: jaydrogers

README.md

@@ -42,7 +42,7 @@ jobs:
           ssh_remote_hostname: "${{ secrets.SSH_REMOTE_HOSTNAME }}"
           registry: "ghcr.io"
           registry-username: "${{ github.actor }}"
-          registry-token: "${{ secrets.GITHUB_TOKEN }}"
+          registry-password: "${{ secrets.GITHUB_TOKEN }}"
           stack_name: "${{ env.PROJECT_NAME }}"
           md5_file_path: "./.infrastructure/conf/traefik/prod/traefik.yml"
           md5_variable_name: "SPIN_MD5_HASH_TRAEFIK_YML"
@@ -60,8 +60,9 @@ The following inputs are available:
 | md5_file_path           | Set the path to the file you would like to get the MD5 checksum for.                             |                                                      | false    |
 | md5_variable_name       | Set the name of the variable to store the MD5 checksum in.                                       | `MD5_CHECKSUM`                                       | false    |
 | registry                | Comma-separated list of container registries to authenticate with (e.g., "docker.io,ghcr.io").   | `docker.io`                                          | false    |
-| registry-token          | The token or password to use to authenticate with the container registry.                        |                                                      | ⚠️ true  |
+| registry-password       | The password to use to authenticate with the container registry.                                 |                                                      | ⚠️ true  |
 | registry-username       | The username to use to authenticate with the container registry.                                 |                                                      | ⚠️ true  |
+| ~~registry-token~~      | ⚠️ **DEPRECATED:** Use `registry-password` instead.                                              |                                                      | false    |
 | ssh_deploy_private_key  | The private key you have authenticated to connect to your server via SSH.                        |                                                      | ⚠️ true  |
 | ssh_deploy_user         | The user that you would like to connect as on the remote server via SSH.                         | `deploy`                                             | ⚠️ true  |
 | ssh_remote_hostname     | The hostname or IP address of the server you want to connect to.                                 |                                                      | ⚠️ true  |
@@ -121,7 +122,7 @@ To ensure you're validating the identity of your server, you can set the `ssh_re
 ```yml
 - uses: serversideup/github-action-docker-swarm-deploy@v3
   with:
-    registry-token: "${{ secrets.GITHUB_TOKEN }}"
+    registry-password: "${{ secrets.GITHUB_TOKEN }}"
     registry-username: "${{ github.actor }}"
     ssh_deploy_private_key: "${{ secrets.SSH_DEPLOY_PRIVATE_KEY }}"
     ssh_remote_hostname: "${{ secrets.SSH_REMOTE_HOSTNAME }}"

action.yml

@@ -41,9 +41,13 @@ inputs:
   registry-username:
     description: 'The username to use to authenticate with the container registry.'
     required: true
-  registry-token:
-    description: 'The token or password to use to authenticate with the container registry.'
+  registry-password:
+    description: 'The password to use to authenticate with the container registry.'
     required: true
+  registry-token:
+    description: '⚠️ DEPRECATED: Use registry-password instead. The token or password to use to authenticate with the container registry.'
+    required: false
+    deprecationMessage: 'registry-token is deprecated. Please use registry-password instead.'
   log_level:
     description: 'The log level to use for the Docker CLI.'
     default: 'debug'
@@ -182,7 +186,7 @@ runs:
       uses: docker/login-action@v3
       with:
         username: ${{ inputs.registry-username }}
-        password: ${{ inputs.registry-token }}
+        password: ${{ inputs.registry-password || inputs.registry-token }}
         registry: ${{ inputs.registry }}
 
     - name: Load .env file and set variables