From 867dae7429725a606f473fa6bd02e89b10227300 Mon Sep 17 00:00:00 2001 From: Klaas Schuijtemaker Date: Mon, 14 Sep 2026 11:50:27 +0200 Subject: [PATCH 1/3] Rename the npm package to @valtimo-plugins/github-plugin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit npm has no rename, so this publishes a new package rather than moving the old one: @valtimo-plugins/github keeps its 1.0.0 and 1.0.1 and gets a deprecation notice pointing here. Anything importing the old name has to change its import; the module and the specification are otherwise identical. Stays at 1.0.1, which is free on the new name and keeps the frontend level with the backend. The backend artifact is untouched — com.ritense.valtimoplugins:github. Eight references moved together, because the build only works if they agree: the package name, the ng-packagr dest, the angular.json project key, the tsconfig path mapping, the build and watch scripts, the sandbox import, the getting-started build command, and the configurator metadata import that the Valtimo configurator resolves the frontend by. Note this leaves the package name the only one in the scope carrying the -plugin suffix: slack, openklant and coworker are all published without it, and -plugin is otherwise the repository naming convention. Done deliberately on request. Verified by building the library: emits @valtimo-plugins/github-plugin@1.0.1 to dist/valtimo-plugins/github-plugin, which is where the publish workflow resolves PUBLISH_PATH to. Lint passes. --- documentation/getting-started.md | 2 +- documentation/release-notes.md | 18 +++++++++++++++++- frontend/angular.json | 2 +- frontend/projects/plugin/ng-package.json | 2 +- frontend/projects/plugin/package.json | 6 +++--- frontend/src/app/app.module.ts | 2 +- frontend/tsconfig.json | 2 +- valtimo-configurator-metadata.json | 2 +- 8 files changed, 26 insertions(+), 10 deletions(-) diff --git a/documentation/getting-started.md b/documentation/getting-started.md index 4cf6827..7e73dd3 100644 --- a/documentation/getting-started.md +++ b/documentation/getting-started.md @@ -145,7 +145,7 @@ They are ordinary files now, and editing one by hand is fine. ```shell ./gradlew :backend:plugin:test # unit tests ./gradlew :backend:plugin:ktlintCheck # formatting, enforced in CI -cd frontend && npx ng build @valtimo-plugins/github +cd frontend && npx ng build @valtimo-plugins/github-plugin ``` The Angular build is the frontend's real check: it compiles every template ahead of time, so diff --git a/documentation/release-notes.md b/documentation/release-notes.md index 2284e82..dec7400 100644 --- a/documentation/release-notes.md +++ b/documentation/release-notes.md @@ -4,7 +4,23 @@ Overview of the changes per version of the GitHub plugin. ## 1.0.1 -Two fixes, both to answers that were wrong rather than missing. +### The frontend package is now `@valtimo-plugins/github-plugin` + +It was published as `@valtimo-plugins/github`. npm has no rename, so this is a new package +rather than a moved one: the old name keeps its 1.0.0 and 1.0.1 and is deprecated with a +pointer here. Anything importing the old name has to change its import — the module and the +specification are otherwise identical. + +``` +npm remove @valtimo-plugins/github +npm install @valtimo-plugins/github-plugin +``` + +The backend artifact is unchanged: `com.ritense.valtimoplugins:github`. + +### Two fixes + +Both to answers that were wrong rather than missing. `get-job-logs` returned no log at all. GitHub serves an Actions log as a redirect to blob storage, that redirect was not followed, and the empty answer was reported as a log that had diff --git a/frontend/angular.json b/frontend/angular.json index bfa784e..101c663 100644 --- a/frontend/angular.json +++ b/frontend/angular.json @@ -135,7 +135,7 @@ } } }, - "@valtimo-plugins/github": { + "@valtimo-plugins/github-plugin": { "projectType": "library", "root": "projects/plugin", "sourceRoot": "projects/plugin/src", diff --git a/frontend/projects/plugin/ng-package.json b/frontend/projects/plugin/ng-package.json index 93494d2..f69be9f 100644 --- a/frontend/projects/plugin/ng-package.json +++ b/frontend/projects/plugin/ng-package.json @@ -1,6 +1,6 @@ { "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json", - "dest": "../../../dist/valtimo-plugins/github", + "dest": "../../../dist/valtimo-plugins/github-plugin", "assets": ["./assets"], "lib": { "entryFile": "src/public_api.ts" diff --git a/frontend/projects/plugin/package.json b/frontend/projects/plugin/package.json index 08a03d1..300d306 100644 --- a/frontend/projects/plugin/package.json +++ b/frontend/projects/plugin/package.json @@ -1,5 +1,5 @@ { - "name": "@valtimo-plugins/github", + "name": "@valtimo-plugins/github-plugin", "license": "EUPL-1.2", "version": "1.0.1", "peerDependencies": { @@ -13,7 +13,7 @@ "tslib": "2.8.1" }, "scripts": { - "build": "ng build @valtimo-plugins/github", - "watch": "ng build @valtimo-plugins/github --watch" + "build": "ng build @valtimo-plugins/github-plugin", + "watch": "ng build @valtimo-plugins/github-plugin --watch" } } diff --git a/frontend/src/app/app.module.ts b/frontend/src/app/app.module.ts index e24da4c..81392b2 100644 --- a/frontend/src/app/app.module.ts +++ b/frontend/src/app/app.module.ts @@ -75,7 +75,7 @@ import {TeamsModule} from "@valtimo/teams"; import {TranslateLoader, TranslateModule} from "@ngx-translate/core"; import {environment} from "../environments/environment"; -import {GitHubPluginModule, githubPluginSpecification,} from "@valtimo-plugins/github"; +import {GitHubPluginModule, githubPluginSpecification,} from "@valtimo-plugins/github-plugin"; export function tabsFactory() { return new Map([ diff --git a/frontend/tsconfig.json b/frontend/tsconfig.json index 745e18c..a24a9f6 100644 --- a/frontend/tsconfig.json +++ b/frontend/tsconfig.json @@ -29,7 +29,7 @@ "@src/*": [ "src/*" ], - "@valtimo-plugins/github": [ + "@valtimo-plugins/github-plugin": [ "projects/plugin/src/public_api.ts" ] } diff --git a/valtimo-configurator-metadata.json b/valtimo-configurator-metadata.json index ddce9b9..d8e7fe0 100644 --- a/valtimo-configurator-metadata.json +++ b/valtimo-configurator-metadata.json @@ -7,7 +7,7 @@ } ], "frontend": { - "import": "@valtimo-plugins/github", + "import": "@valtimo-plugins/github-plugin", "codeAdditions": [ { "spec": "githubPluginSpecification", From 072c0d63d4df73eac31e2b7d1a33f188e770bc7b Mon Sep 17 00:00:00 2001 From: Klaas Schuijtemaker Date: Mon, 14 Sep 2026 11:56:58 +0200 Subject: [PATCH 2/3] Rewrite the release notes for the people who read them MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit They were written for whoever had just changed the code: redirects to blob storage, which header was deliberately not forwarded, the name of the paging method. None of that tells an administrator or a process designer whether the release affects them. Rewritten around what you see and do. Each entry now leads with the action as it is labelled in the admin UI — Get job logs, Maximum number of results — says what went wrong from the using end, and says what to expect now. The result fields a diagram actually branches on, `truncated` and the availability of a log, are kept, because those are on screen too; everything behind them is gone. Same audience as handleiding.md. The fixes now come before the package rename, since the fixes are what a reader is checking for and the rename only concerns whoever installs Valtimo. No facts changed, and nothing was dropped: the package rename, the deprecation of the old name and the unchanged backend are all still there, in a sentence each rather than a section each. --- documentation/release-notes.md | 58 +++++++++++++++++++--------------- 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/documentation/release-notes.md b/documentation/release-notes.md index dec7400..41b2d00 100644 --- a/documentation/release-notes.md +++ b/documentation/release-notes.md @@ -4,41 +4,47 @@ Overview of the changes per version of the GitHub plugin. ## 1.0.1 -### The frontend package is now `@valtimo-plugins/github-plugin` +### Get job logs now actually shows the log -It was published as `@valtimo-plugins/github`. npm has no rename, so this is a new package -rather than a moved one: the old name keeps its 1.0.0 and 1.0.1 and is deprecated with a -pointer here. Anything importing the old name has to change its import — the module and the -specification are otherwise identical. +The action said it had read the log and then handed back nothing. Anyone using it to find out +why a build failed got an empty answer — and, worse, one that looked like a job that had run +fine and said nothing at all. -``` -npm remove @valtimo-plugins/github -npm install @valtimo-plugins/github-plugin -``` +It now returns the last lines of the log, as many as the **Number of lines** field asks for. +When GitHub will not hand the log over — the run has expired, or the job has not started yet +— the result says so, with the reason, instead of passing an empty log off as a log that was +read. -The backend artifact is unchanged: `com.ritense.valtimoplugins:github`. +If you have a process that picks up a failing build and reports back what went wrong, this is +the release that makes it work. -### Two fixes +### A complete list is no longer reported as cut short -Both to answers that were wrong rather than missing. +Every list action — issues, pull requests, repositories, workflow runs — reports `truncated` +next to its items, so a process can tell "this is all of them" from "there were more than I +was allowed to fetch". -`get-job-logs` returned no log at all. GitHub serves an Actions log as a redirect to blob -storage, that redirect was not followed, and the empty answer was reported as a log that had -been read — so the one action whose purpose is to say why a job failed said nothing, and said -it had succeeded. The redirect is now followed, deliberately without the configuration's -token: the storage URL carries its own signature, and the host is not GitHub. A log that -GitHub will not hand over — an expired run, a job still starting — now reports `available` -false with the reason. +When a list happened to hold exactly as many items as **Maximum number of results** allowed, +it was marked as cut short even though nothing had been left behind. A process branching on +that flag took the "there is more to fetch" route every single time. `truncated` now means +items were genuinely left out. -A list action that stopped exactly on its configured limit reported `truncated` true even -when the list had ended there. A process branching on that flag took the "there is more to -do" path on every run. Truncation now means something was actually left behind. +### Installing: the frontend has a new package name + +The plugin's frontend is now published as `@valtimo-plugins/github-plugin`. It used to be +`@valtimo-plugins/github`, which stays available but is deprecated and gets no further +updates. + +Nothing changes in the admin UI. Existing plugin configurations, process links and result +variables keep working, and there is nothing to redo in your diagrams. Only whoever installs +Valtimo has to point at the new name once. The backend is unchanged. ## 1.0.0 First release. Thirty-three actions covering issues, pull requests, reviews, checks, files, -branches and project boards, plus `rest-request` and `graphql-query` for anything they do not -reach. +branches and project boards, plus **REST request** and **GraphQL query** for the corners of +GitHub the other actions do not reach. -Actions only — nothing in this plugin polls, and installing it adds no database tables. A -process that should run on a schedule says so with a BPMN timer start event. +The plugin only acts when a process asks it to. It never watches GitHub on its own, so a +process that should check something on a schedule says so with a timer start event in the +diagram. Installing it adds nothing to the database. From f7ad071a3f4ec4910a646d991c100f44e71b38be Mon Sep 17 00:00:00 2001 From: Klaas Schuijtemaker Date: Mon, 14 Sep 2026 12:00:24 +0200 Subject: [PATCH 3/3] Rename the backend artifact to com.ritense.valtimoplugins:github-plugin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Follows the frontend, so both halves of the plugin publish under the same name. Maven Central has no delete either, so this is a new artifact rather than a moved one: com.ritense.valtimoplugins:github keeps its 1.0.0 and 1.0.1 and needs a deprecation pointing here. Anything depending on the old coordinates has to change them. Stays at 1.0.1, which is free on the new artifactId and keeps the backend level with the frontend. Deliberately NOT renamed: the plugin key. PLUGIN_KEY and the frontend's matching pluginId stay "github", because that key is written into every plugin configuration and every process link in every deployment's database. Moving it would orphan them all — that is a migration, not a rename. Nothing resolves the artifact from the key, so the two names differing is only cosmetic. valtimo-configurator-metadata.json keeps "name": "github" for the same reason, and lists both new imports explicitly. Release notes corrected: they claimed the backend was unchanged, which this makes untrue. Both old and new names are now named side by side. Verified: the generated POM resolves to com.ritense.valtimoplugins:github-plugin:1.0.1, the plugin key is unmoved in all three places that have to agree on it, and 80 tests and ktlint pass. --- backend/plugin/plugin.properties | 2 +- documentation/release-notes.md | 18 ++++++++++++------ valtimo-configurator-metadata.json | 2 +- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/backend/plugin/plugin.properties b/backend/plugin/plugin.properties index d31066b..1d0c4ca 100644 --- a/backend/plugin/plugin.properties +++ b/backend/plugin/plugin.properties @@ -1,3 +1,3 @@ pluginGroupId=com.ritense.valtimoplugins -pluginArtifactId=github +pluginArtifactId=github-plugin pluginVersion=1.0.1 diff --git a/documentation/release-notes.md b/documentation/release-notes.md index 41b2d00..0cea228 100644 --- a/documentation/release-notes.md +++ b/documentation/release-notes.md @@ -29,15 +29,21 @@ it was marked as cut short even though nothing had been left behind. A process b that flag took the "there is more to fetch" route every single time. `truncated` now means items were genuinely left out. -### Installing: the frontend has a new package name +### Installing: both halves have a new name -The plugin's frontend is now published as `@valtimo-plugins/github-plugin`. It used to be -`@valtimo-plugins/github`, which stays available but is deprecated and gets no further -updates. +The plugin is now published under `github-plugin` rather than `github`, front and back: + +| | Was | Is now | +| --- | --- | --- | +| Frontend | `@valtimo-plugins/github` | `@valtimo-plugins/github-plugin` | +| Backend | `com.ritense.valtimoplugins:github` | `com.ritense.valtimoplugins:github-plugin` | + +The old names stay available but are deprecated and get no further updates. Nothing changes in the admin UI. Existing plugin configurations, process links and result -variables keep working, and there is nothing to redo in your diagrams. Only whoever installs -Valtimo has to point at the new name once. The backend is unchanged. +variables keep working, and there is nothing to redo in your diagrams — the plugin is still +called **GitHub** on screen and still identifies itself as `github` underneath. Only whoever +installs Valtimo has to point at the two new names once. ## 1.0.0 diff --git a/valtimo-configurator-metadata.json b/valtimo-configurator-metadata.json index d8e7fe0..5f9da0e 100644 --- a/valtimo-configurator-metadata.json +++ b/valtimo-configurator-metadata.json @@ -3,7 +3,7 @@ "version": 1, "backend": [ { - "import": "com.ritense.valtimoplugins:github" + "import": "com.ritense.valtimoplugins:github-plugin" } ], "frontend": {