Merge pull request #5 from RocketChat/ci/build-and-release-workflows

Add CI and release GitHub Actions workflows

Author: rodrigok

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Lint, typecheck & package
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+          cache-dependency-path: external-chat/package-lock.json
+
+      - name: Install dependencies
+        working-directory: external-chat
+        run: npm ci
+
+      - name: Lint
+        working-directory: external-chat
+        run: npm run lint
+
+      - name: Typecheck
+        working-directory: external-chat
+        run: npx tsc --noEmit
+
+      - name: Build & package the zip (no version bump)
+        run: |
+          make package
+          VERSION=$(node -p "require('./external-chat/package.json').version")
+          echo "VERSION=$VERSION" >> "$GITHUB_ENV"
+
+      - name: Upload plugin zip artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: external-chat-v${{ env.VERSION }}
+          path: external-chat-v${{ env.VERSION }}.zip
+          if-no-files-found: error

.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release
+
+# Manually-triggered release: reads the current version from package.json,
+# builds the plugin zip, then creates a matching git tag and GitHub release
+# with the zip attached as an asset. Bump the version (e.g. `make bump`) and
+# commit it before running this.
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write # required to create tags and releases
+
+jobs:
+  release:
+    name: Tag & release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+          cache-dependency-path: external-chat/package-lock.json
+
+      - name: Install dependencies
+        working-directory: external-chat
+        run: npm ci
+
+      - name: Read version from package.json
+        run: echo "VERSION=$(node -p "require('./external-chat/package.json').version")" >> "$GITHUB_ENV"
+
+      - name: Ensure this version is not already released
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          if gh release view "v$VERSION" >/dev/null 2>&1; then
+            echo "::error::Release v$VERSION already exists. Bump the version in external-chat/package.json first."
+            exit 1
+          fi
+
+      - name: Build & package the zip
+        run: make package
+
+      - name: Create tag & GitHub release with the zip asset
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "v$VERSION" \
+            "external-chat-v$VERSION.zip" \
+            --target "$GITHUB_SHA" \
+            --title "external-chat v$VERSION" \
+            --generate-notes

Makefile

@@ -6,26 +6,33 @@ DIST        := $(PROJECT)/dist
 WEBAPP3     := $(ROOT)/webapp3
 PLUGIN_DIR  := $(WEBAPP3)/branding/plugins/external-chat
 
-.PHONY: all bump build deploy package clean
+.PHONY: all release bump build deploy package clean
 
-all: package
+# Default: a full release (bumps the version, then packages).
+all: release
 
-# 1. Bump the minor version in external-chat/package.json (no git commit/tag).
-#    Done first so the build embeds the new version in its logs.
+# Full release: bump the minor version first, then build & package with it.
+# Uses sub-makes so the bump always completes before the build starts.
+release:
+	$(MAKE) bump
+	$(MAKE) package
+
+# Bump the minor version in external-chat/package.json (no git commit/tag).
 bump:
 	cd $(PROJECT) && npm version minor --no-git-tag-version
 
-# 2. Build the external-chat project.
-build: bump
+# Build the external-chat project.
+build:
 	cd $(PROJECT) && npm run build
 
-# 3. Copy the freshly built dist into webapp3/branding/plugins/external-chat.
+# Copy the freshly built dist into webapp3/branding/plugins/external-chat.
 deploy: build
 	rm -rf $(PLUGIN_DIR)
 	mkdir -p $(PLUGIN_DIR)
 	cp -R $(DIST)/. $(PLUGIN_DIR)/
 
-# 4. Zip the webapp3 bundle into external-chat-v<version>.zip, named from package.json.
+# Zip the webapp3 bundle into external-chat-v<version>.zip using the CURRENT
+# version from package.json (no bump). This is what CI calls.
 package: deploy
 	@VERSION=$$(node -p "require('$(PROJECT)/package.json').version"); \
 	cd $(ROOT) && zip -r -q external-chat-v$$VERSION.zip webapp3 -x '*.DS_Store'; \

README.md

@@ -187,33 +187,60 @@ plugin at runtime (`plugin: external-chat loaded v<version>`).
 
 ## Building & packaging with the Makefile
 
-Run all `make` commands from the **repository root**. The pipeline bumps the
-version, builds the plugin, copies it into the branding bundle, and produces a
-versioned zip.
+Run all `make` commands from the **repository root**.
 
 ```bash
-make            # same as `make package` — runs the full pipeline
+make            # full release: bump the minor version, build, then package
+make package    # build & package using the CURRENT version (no bump)
 ```
 
 ### Targets
 
-| Target | What it does |
-| --- | --- |
-| `make bump` | Bumps the **minor** version in `external-chat/package.json` (`npm version minor --no-git-tag-version` — no git commit or tag). |
-| `make build` | Runs `bump`, then `npm run build` so the new version is embedded in the bundle. |
-| `make deploy` | Runs `build`, then copies `external-chat/dist/` into `webapp3/branding/plugins/external-chat/`. |
-| `make package` | Runs `deploy`, then zips the `webapp3/` folder into `external-chat-v<version>.zip` at the repo root. |
-| `make all` | Alias for `make package` (the default target). |
-| `make clean` | Removes `external-chat/dist/` and the deployed plugin folder. |
-
-Dependency chain: `package → deploy → build → bump`.
+| Target | What it does | Bumps version? |
+| --- | --- | --- |
+| `make release` | Bumps the version, then runs `package`. | ✅ |
+| `make all` | Alias for `make release` (the default target). | ✅ |
+| `make bump` | Bumps the **minor** version in `external-chat/package.json` (`npm version minor --no-git-tag-version` — no git commit or tag). | ✅ |
+| `make build` | Runs `npm run build`. | — |
+| `make deploy` | Runs `build`, then copies `external-chat/dist/` into `webapp3/branding/plugins/external-chat/`. | — |
+| `make package` | Runs `deploy`, then zips the `webapp3/` folder into `external-chat-v<version>.zip` at the repo root, using the current `package.json` version. | — |
+| `make clean` | Removes `external-chat/dist/` and the deployed plugin folder. | — |
+
+Dependency chains: `release → bump → package → deploy → build`. Only `release`,
+`all`, and `bump` change the version — `build`/`deploy`/`package` use the current
+one, so **CI and one-off packaging never bump** (CI runs `make package`).
 
 ### Output
 
 `make` produces `external-chat-v<version>.zip` in the repo root, where `<version>`
-is the freshly bumped value from `package.json` (e.g. `external-chat-v1.4.0.zip`).
-The zip contains the full `webapp3/` branding bundle, ready to upload.
+is the value in `package.json` (e.g. `external-chat-v1.4.0.zip`) — freshly bumped
+by `make`/`make release`, or unchanged by `make package`. The zip contains the
+full `webapp3/` branding bundle, ready to upload.
+
+## Continuous integration
+
+`.github/workflows/ci.yml` runs on pushes to `main`, on pull requests, and on
+manual dispatch. It installs dependencies (`npm ci`), then runs **lint**,
+**typecheck** (`tsc --noEmit`), and **`make package`** (build + zip, **no version
+bump**). The resulting `external-chat-v<version>.zip` is uploaded as a downloadable
+workflow artifact named `external-chat-v<version>`.
+
+## Releasing
+
+`.github/workflows/release.yml` is a **manually triggered** workflow
+(Actions → *Release* → *Run workflow*). It reads the current version from
+`external-chat/package.json`, builds the zip (`make package`, no bump), then
+creates a `v<version>` git tag and a GitHub release with
+`external-chat-v<version>.zip` attached as an asset. Release notes are
+auto-generated from the changes since the previous release.
+
+Typical flow:
+
+```bash
+make bump                 # 1. bump the minor version in package.json
+git commit -am "release"  # 2. commit the bump (and push)
+# 3. run the "Release" workflow from the Actions tab
+```
 
-> ⚠️ **Every `make` (or `make build`/`deploy`/`package`) bumps the minor version**,
-> because `build` depends on `bump`. To build *without* bumping, run
-> `cd external-chat && npm run build` directly and copy `dist/` yourself.
+If a release for the current version already exists, the workflow fails with a
+reminder to bump first (it never overwrites an existing tag/release).

external-chat/src/index.ts

@@ -1,7 +1,8 @@
-import { ButtonRPCPayload, registerPlugin } from '@pexip/plugin-api'
+import { registerPlugin } from '@pexip/plugin-api'
+import type { ButtonRPCPayload } from '@pexip/plugin-api'
 import { version } from '../package.json'
 
-function fireParentMessage(action: string, data?: Record<string, unknown>) {
+function fireParentMessage(action: string, data?: Record<string, unknown>): void {
   action = `pexip:plugin:external-chat/${action}`;
 
   console.log(`plugin: external-chat sending message to parent: ${action}`, data);
@@ -26,8 +27,8 @@ const buttonConfig: ButtonRPCPayload['toolbar']['add'] = {
 
 const button = await plugin.ui.addButton(buttonConfig);
 
-function renderButton() {
-  button.update({
+function renderButton(): void {
+  void button.update({
     ...buttonConfig,
     isActive: isChatAtive,
     tooltip: isChatAtive ? 'Close Chat' : 'Open Chat',
@@ -37,12 +38,12 @@ function renderButton() {
   });
 }
 
-function setChatActive(isActive: boolean) {
+function setChatActive(isActive: boolean): void {
   isChatAtive = isActive;
   renderButton();
 }
 
-function setBadgeVisible(isVisible: boolean) {
+function setBadgeVisible(isVisible: boolean): void {
   isBadgeVisible = isVisible;
   renderButton();
 }
@@ -51,7 +52,7 @@ function setBadgeVisible(isVisible: boolean) {
 type DialOutParams = Parameters<typeof plugin.conference.dialOut>[0];
 
 // Dial out to a destination on behalf of the top window and report the outcome back.
-async function dialOut(params: DialOutParams) {
+async function dialOut(params: DialOutParams): Promise<void> {
   try {
     const participant = await plugin.conference.dialOut(params);
     fireParentMessage('dial-out-success', {