@mercury-fw/channel-google-chat 0.11.0 → 0.11.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @mercury-fw/channel-google-chat
 
+## 0.11.1
+
+### Patch Changes
+
+- c7806ea: README: the setup steps on each service's console follow its official documentation and link it.
+
+  - Google Chat: the Chat app's configuration uses Google's current labels (**Enable interactive features**, **Add a command**, **Slash command name**, a Command ID from 1 to 1000), says Visibility takes up to five people or groups, and links Google's guides to the consent screen, the Pub/Sub quickstart, the Chat API configuration and commands.
+  - Jira: links Atlassian's guides to service account credentials and to OAuth 2.0 (3LO) apps, and says the `app.jira.no-issues` text is in `locales/en.json` only in an app created with Jira.
+  - Atlassian admin: where an organization admin creates the API key, that it's shown once and expires, and Atlassian's guide.
+  - Bitbucket: where a workspace's OAuth consumer is added, and Atlassian's guide.
+  - ZITADEL: ZITADEL's guides to a service account's key and to applications.
+
+- f631dd5: README: a link to the package's page on Mercury's documentation site (https://lucabro81.github.io/mercury-fw/), published from this release on. The HTTP channel's README points to the HTTP API reference there, and the core's memory section to the page that explains it.
+
 ## 0.11.0
 
 ### Minor Changes

package/README.md

@@ -2,6 +2,8 @@
 
 Puts a [Mercury](https://github.com/lucabro81/mercury-fw) agent on Google Chat as a registered Chat app: it receives messages through a Pub/Sub subscription and replies through the Chat API, with status cards while it works and a button for the actions that need confirmation.
 
+On Mercury's documentation site: [its page](https://lucabro81.github.io/mercury-fw/plugins/channel-google-chat/).
+
 ```bash
 bun add @mercury-fw/channel-google-chat
 ```
@@ -134,7 +136,7 @@ Open [Google Auth Platform → Branding](https://console.cloud.google.com/auth/b
 3. **Contact Information**: your address. Click **Next**.
 4. Check **I agree to the Google API Services: User Data Policy**, click **Continue**, then **Create**.
 
-No scopes to add: an internal app doesn't list them.
+No scopes to add: an internal app doesn't list them. Google's own guide to this screen is [Configure the OAuth consent screen](https://developers.google.com/workspace/guides/configure-oauth-consent).
 
 ### 7. Configure the Chat app (Cloud Console)
 
@@ -142,14 +144,14 @@ Open the Chat API's configuration page for the project, `https://console.develop
 
 1. **Build this Chat app as a Google Workspace add-on**: unchecked (confirm in the dialog if it asks).
 2. **App name**: the name users search for in Chat (up to 25 characters). **Avatar URL**: an HTTPS link to a square image. **Description**: one line (up to 40 characters).
-3. **Interactive features**: enabled. Without them nobody can write to the app or click its confirmation buttons.
+3. **Interactive features**: turn on **Enable interactive features**. Without them nobody can write to the app or click its confirmation buttons.
 4. **Functionality**: check **Join spaces and group conversations**.
 5. **Connection settings**: pick **Cloud Pub/Sub** and paste the topic's full name, `projects/<PROJECT_ID>/topics/<TOPIC>`.
-6. **Visibility**: check **Make this Google Chat app available to specific people and groups in <your domain>** and enter who can use it (people or a group).
+6. **Visibility**: check **Make this Google Chat app available to specific people and groups in <your domain>** and enter who can use it: up to five people or Google Groups (a group covers everyone in it).
 7. **Logs**: check **Log errors to Logging**, so a delivery error from Chat shows up in the project's logs.
-8. **Commands**: add a command of type **Slash command**, named `/stop`, with any free **Command ID** (`1` on a new app) and a description such as "Stop the answer in progress". The channel recognises it by its name, so the id is up to you.
+8. **Commands**: click **Add a command**, pick **Slash command** as **Command type**, enter `/stop` as **Slash command name**, any free **Command ID** from 1 to 1000 (`1` on a new app) and a **Description** of up to 50 characters, such as "Stop the answer in progress". Leave **Open a dialog** unchecked, and click **Save** in the form. The channel recognises the command by its name, so the id is up to you.
 
-Click **Save**. The field names here come from Google's own Pub/Sub quickstart; Console moves things around now and then, so trust the meaning over the exact position.
+Click **Save**. These labels follow Google's own guides, which say more about each field: [Build a Google Chat app behind a firewall with Pub/Sub](https://developers.google.com/workspace/chat/quickstart/pub-sub), [Configure the Google Chat API](https://developers.google.com/workspace/chat/configure-chat-api) and [Respond to Google Chat app commands](https://developers.google.com/workspace/chat/commands). Console moves things around now and then, so trust the meaning over the exact position.
 
 ### 8. Start and try it
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/channel-google-chat",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "@mercury-fw/channel-types": ">=0.54.0 <1.0.0"
   },
   "devDependencies": {
-    "@mercury-fw/channel-types": "0.58.0",
+    "@mercury-fw/channel-types": "0.59.2",
     "@mercury-fw/typescript-config": "*",
     "@types/bun": "^1.4.2",
     "typescript": "^6.0.3"