Rename to github-plugin (frontend and backend), plus UI-focused release notes - #2
Merged
Merged
Conversation
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.
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.
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.
Klaas-Ritense
changed the title
Member
Author
Update: the backend artifact is renamed tooExtended beyond the original npm-only scope, on request.
Both stay at Deliberately not renamed: the plugin key
That key is written into every plugin configuration and every process link in every deployment's database ( Note on conventionI checked Maven Central as well as npm: Release notes correctedThey previously said "The backend is unchanged", which this makes untrue. Both old and new names are now listed side by side, with a note that nothing changes in the admin UI. Follow-up needed after merge (needs credentials I do not have)And the equivalent for Maven Central — Verification
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Publishes the frontend as
@valtimo-plugins/github-plugin, per request.What this is
npm has no rename. This publishes a new package;
@valtimo-plugins/githubkeeps its1.0.0and1.0.1permanently and needs a deprecation notice pointing here (see below — that step needs npm credentials and can't run from CI as configured).Stays at
1.0.1— 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
The build only works if they all agree:
projects/plugin/package.jsonname,build+watchscriptsprojects/plugin/ng-package.jsondestangular.jsontsconfig.jsonsrc/app/app.module.tsdocumentation/getting-started.mdvaltimo-configurator-metadata.jsonimportthe configurator resolves the frontend byHeads-up worth recording
This makes the package the only one in the scope carrying
-plugin. I probed the registry:@valtimo-plugins/slack,@valtimo-plugins/openklantand@valtimo-plugins/coworkerare all published without the suffix, and the-pluginform doesn't exist for any of them — it's the repository naming convention. The backend artifact and the configurator metadata also use the baregithub. Flagged before doing it; going ahead on request.Follow-up that is not in this PR
Deprecating the old package needs npm credentials I don't have locally, and the publish workflow has no step for it:
Worth running right after this merges, so nobody installs the old name.
Verification
@valtimo-plugins/github-plugin@1.0.1todist/valtimo-plugins/github-pluginPUBLISH_PATHresolution against the newdest— resolves and exists