Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion backend/plugin/plugin.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
pluginGroupId=com.ritense.valtimoplugins
pluginArtifactId=github
pluginArtifactId=github-plugin
pluginVersion=1.0.1
2 changes: 1 addition & 1 deletion documentation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
58 changes: 43 additions & 15 deletions documentation/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,53 @@ Overview of the changes per version of the GitHub plugin.

## 1.0.1

Two fixes, both to answers that were wrong rather than missing.
### Get job logs now actually shows the log

`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.
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.

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.
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.

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.

### A complete list is no longer reported as cut short

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".

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.

### Installing: both halves have a new name

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 — 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

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.
2 changes: 1 addition & 1 deletion frontend/angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
}
}
},
"@valtimo-plugins/github": {
"@valtimo-plugins/github-plugin": {
"projectType": "library",
"root": "projects/plugin",
"sourceRoot": "projects/plugin/src",
Expand Down
2 changes: 1 addition & 1 deletion frontend/projects/plugin/ng-package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
6 changes: 3 additions & 3 deletions frontend/projects/plugin/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@valtimo-plugins/github",
"name": "@valtimo-plugins/github-plugin",
"license": "EUPL-1.2",
"version": "1.0.1",
"peerDependencies": {
Expand All @@ -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"
}
}
2 changes: 1 addition & 1 deletion frontend/src/app/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<string, object>([
Expand Down
2 changes: 1 addition & 1 deletion frontend/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"@src/*": [
"src/*"
],
"@valtimo-plugins/github": [
"@valtimo-plugins/github-plugin": [
"projects/plugin/src/public_api.ts"
]
}
Expand Down
4 changes: 2 additions & 2 deletions valtimo-configurator-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"version": 1,
"backend": [
{
"import": "com.ritense.valtimoplugins:github"
"import": "com.ritense.valtimoplugins:github-plugin"
}
],
"frontend": {
"import": "@valtimo-plugins/github",
"import": "@valtimo-plugins/github-plugin",
"codeAdditions": [
{
"spec": "githubPluginSpecification",
Expand Down
Loading