@dual-os/github-api 0.0.0-stage → 6.0.5

package/LICENSE

@@ -0,0 +1,28 @@
+All rights reserved.
+
+This package is proprietary and is not licensed for public use or redistribution.
+Use and distribution require permission from the rights holder under a separate agreement.
+
+Portions adapted from HumanLayer effect-channels:
+
+MIT License
+
+Copyright (c) 2026 HumanLayer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# github-api: API and Agent Channel
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This plugin includes the existing API Actions and Workflow Triggers plus the github-api/agent-issues Agent Channel.
+Existing action/trigger IDs, schemas and API authentication methods are unchanged. The additional
+Channel authentication is listed at plugin level; per-action authentication subsets are intentionally
+deferred. Use existing API Connections for Actions/Triggers and the Channel credentials below for
+agent conversations. No migration of unused standalone Channel installations is provided.
+
+## GitHub App Channel
+
+The `github-api/agent-issues` Agent Channel serves a customer's own
+GitHub App. It treats each issue or pull request as one conversation. Deployment settings
+choose where (`repositories` of the installation), who (`access`, `allowedSenderKeys`, plus the
+`mentionPermission` role floor) and when (`respondTo`: `mentions` or `all_messages`) a message
+starts a turn. Input identity comes
+from the signed creation payload; changing an unsigned delivery header cannot create another input.
+
+Use the definition-only plugin from `@dual-os/github-api/definition`, or the executable
+plugin from `@dual-os/github-api` or `@dual-os/github-api/executable`. Credentials come from the Connection:
+App ID, PEM private key and webhook secret. Existing API
+Connections and published actions keep their existing contracts.
+Activation sets the App's webhook URL, secret and JSON content type with the App JWT; the
+customer still sets the App's permissions and events, which activation checks.
+
+The provider supports comments, comment updates and deletion, portable reactions,
+a plan comment and bounded conversation reads. Explicit reactions to review comments
+use the pull-request review-comment API; answers use the issue-comment API.
+Automatic activity is unavailable. It does not ingest attachments, review summaries or edited messages.
+References to previous bot comments are checked against the App's bot author and
+the issue before a comment update, deletion, reaction or plan replacement.
+
+Portions are adapted from [HumanLayer effect-channels](https://github.com/humanlayer/effect-channels),
+copyright 2026 HumanLayer, MIT. The license notice is included in `LICENSE`.
+The initial Dual adaptation was recovered from the earlier Claude implementation
+and completed for the current SDK and consuming server test seam with GPT-6.1 Sol.