Enhance plugin packaging workflow and add detailed README for OpenID Connect API Proxy

Author: fujita-h

.github/workflows/package-and-release.yml

@@ -46,20 +46,32 @@ jobs:
             exit 1
           fi
           echo "dir_name=$dir_name" >> $GITHUB_OUTPUT
-      - name: Get plugin name from manifest.yaml
-        id: get_plugin_name
+      - name: Get plugin info from manifest.yaml
+        id: get_plugin_info
         run: |
+          plugin_author=$(yq -r '.author | select(.)' manifest.yaml)
+          if [ -z "$plugin_author" ]; then
+            echo "Plugin author not found in manifest.yaml"
+            exit 1
+          fi
           plugin_name=$(yq -r '.name | select(.)' manifest.yaml)
           if [ -z "$plugin_name" ]; then
             echo "Plugin name not found in manifest.yaml"
             exit 1
           fi
+          plugin_version=$(yq -r '.version | select(.)' manifest.yaml)
+          if [ -z "$plugin_version" ]; then
+            echo "Plugin version not found in manifest.yaml"
+            exit 1
+          fi
+          echo "plugin_author=$plugin_author" >> $GITHUB_OUTPUT
           echo "plugin_name=$plugin_name" >> $GITHUB_OUTPUT
+          echo "plugin_version=$plugin_version" >> $GITHUB_OUTPUT
       - name: Package the plugin
         id: package
         run: |
           dir_name="${{ steps.get_repo_dir_name.outputs.dir_name }}"
-          plugin_name="${{ steps.get_plugin_name.outputs.plugin_name }}"
+          plugin_name="${{ steps.get_plugin_info.outputs.plugin_author }}-${{ steps.get_plugin_info.outputs.plugin_name }}_${{ steps.get_plugin_info.outputs.plugin_version }}"
           plugin_file="../${plugin_name}.difypkg"
           echo "Packaging $plugin_name..."
           dify plugin package ../$dir_name -o $plugin_file

README.difypkg.md

@@ -0,0 +1,91 @@
+# Overview
+
+This plugin provides the same API endpoints as the Dify Chat/Workflow API, but uses OpenID Connect authentication instead of Dify's API key authentication.
+
+You can use the endpoints created by this plugin to provide per-user authentication to the API.
+
+# Features
+
+## OpenID Connect authentication
+
+This plugin uses OpenID Connect authentication to authenticate users. You can access the API with the access token obtained by authenticating with OpenID Connect.
+
+## User parameter replacement
+
+You can also replace the `user` parameter specified in the original API with OpenID Connect authenticated claim data. For example, if you replace it with an email address, the user's email address will be displayed on the Dify app log screen.
+
+## Input claim data to the Chat/Workflow App
+
+Plugin automatically inputs the claim data obtained by OpenID Connect authentication into the Chat/Workflow App. You can use the claim data in the Chat/Workflow App.
+
+To use the claim data in the Chat/Workflow App, you need to specify the claim data name to the Start node's `input` parameter. For example, if you specify `__oidc_email` to the `input` parameter, you can use the email address in the Chat/Workflow App.
+
+# Configuration
+
+## 1. Install the plugin
+
+Install the plugin by clicking on the **Install** button.
+
+## 2. Add a endpoint
+
+Open the plugin, and click on the **+** button.
+
+![](./_assets/img_add_endpoint.jpg)
+
+Input the OpenID Connect configuration and the API endpoint you want to relay, and click on the **Save** button.
+
+![](./_assets/img_endpoint_setting.jpg)
+
+## 3. Access the endpoint
+
+Now you can use the endpoint you created. You can see the list of API endpoints.
+
+![](./_assets/img_endpoint_list.jpg)
+
+For example, the original Dify API endpoint for sending a chat message is `https://api.dify.ai/v1/chat-messages`.
+
+```shell
+curl -X POST 'https://api.dify.ai/v1/chat-messages' \
+--header 'Authorization: Bearer {api_key}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "inputs": {},
+    "query": "What are the specs of the iPhone 13 Pro Max?",
+    "response_mode": "streaming",
+    "conversation_id": "",
+    "user": "abc-123",
+    "files": [
+      {
+        "type": "image",
+        "transfer_method": "remote_url",
+        "url": "https://cloud.dify.ai/logo/logo-site.png"
+      }
+    ]
+}'
+```
+In this scnario, the OpenID Connect API Proxy endpoint for sending a chat message is `https://daemon-plugin.dify.dev/SUF6pe2H3CccPBwY7H.../chat-messages`.
+
+```shell
+curl -X POST 'https://daemon-plugin.dify.dev/SUF6pe2H3CccPBwY7H.../chat-messages' \
+--header 'Authorization: Bearer {OpenID Connect Access Token}' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "inputs": {},
+    "query": "What are the specs of the iPhone 13 Pro Max?",
+    "response_mode": "streaming",
+    "conversation_id": "",
+    "user": "abc-123",
+    "files": [
+      {
+        "type": "image",
+        "transfer_method": "remote_url",
+        "url": "https://cloud.dify.ai/logo/logo-site.png"
+      }
+    ]
+}'
+```
+
+# Report Issues and Contributing
+
+Please report any issues to the [GitHub repository](https://github.com/fujita-h/dify-plugin-oidc-api-proxy).  
+This plugin is open-source and contributions are welcome.

README.md

@@ -3,8 +3,8 @@
 # OpenID Connect API Proxy 
 
 [![GitHub Repo](https://img.shields.io/badge/GitHub_Repo-fujita--h/dify--plugin--oidc--api--proxy-blue?logo=github)](https://github.com/fujita-h/dify-plugin-oidc-api-proxy)  
-![GitHub Release](https://img.shields.io/github/v/release/fujita-h/dify-plugin-oidc-api-proxy)
-![GitHub License](https://img.shields.io/github/license/fujita-h/dify-plugin-oidc-api-proxy)
+[![GitHub Release](https://img.shields.io/github/v/release/fujita-h/dify-plugin-oidc-api-proxy)](https://github.com/fujita-h/dify-plugin-oidc-api-proxy/releases)
+[![GitHub License](https://img.shields.io/github/license/fujita-h/dify-plugin-oidc-api-proxy)](https://github.com/fujita-h/dify-plugin-oidc-api-proxy/blob/main/LICENSE)
 
 This plugin relays the API provided by Dify chat/workflow with OpenID Connect authentication enabled.
 
@@ -30,6 +30,10 @@ Plugin automatically inputs the claim data obtained by OpenID Connect authentica
 
 To use the claim data in the Chat/Workflow App, you need to specify the claim data name to the Start node's `input` parameter. For example, if you specify `__oidc_email` to the `input` parameter, you can use the email address in the Chat/Workflow App.
 
+## Configuration and Usage
+
+See [Plugin README](./README.difypkg.md) for configuration and usage details.
+
 ## Contributing
 
-This plugin is open-source and contributions are welcome. Please visit the GitHub repository to contribute.
+This plugin is open-source and contributions are welcome.