Skip to content

fix: attribute the js packages to UiPath and ship the client readme [HDENS-7797] - #161

Merged
lucarachiteanu merged 1 commit into
masterfrom
fix/hdens-7797-js-package-author
Sep 16, 2026
Merged

lucarachiteanu merged 1 commit into
masterfrom
fix/hdens-7797-js-package-author

Conversation

@lucarachiteanu

@lucarachiteanu lucarachiteanu commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

HDENS-7797

Follow-up to #158 (repository/bugs/homepage) and #159 (LICENSE in the tarball). Two things were still wrong with what we publish:

  1. author was "Eduard Dumitru" — the last personal attribution left on the packages.
  2. The README in both tarballs was a one-line placeholder from assets/<target>/README.md, so the registry page for @uipath/coreipc showed a heading and nothing else. The actual JS client documentation lived in src/Clients/js/README.md and never shipped.

What changed

  • src/Clients/js/package.json: "author": "UiPath". This file is packageBase for GeneratePackageJsonPlugin, so the value lands in both generated manifests without touching the prepack output.
  • webpack.common.js: copy README.md and readme-assets/ into each generated package, next to the LICENSE pattern fix: ship the MIT LICENSE inside both js packages #159 added.
  • Deleted the three placeholder assets/*/README.md one-liners — leaving them would make two copy patterns emit a different README.md to the same path.
  • One relative link in the client doc (../../../README.md, the .NET README) is now the absolute repo URL, since nothing above package/ exists in a tarball. The readme-assets/ images stay relative and now travel with the package.

The same doc ships in both packages, on purpose

@uipath/coreipc-web is the browser build of the same client: src/std plus src/web, WebSockets only — isPipe exists only under src/node, so named pipes are genuinely Node-only. The doc is written for both (its package table lists both, and the usage examples show both import specifiers side by side, marking pipes "exclusive to Node.js"), so shipping one file keeps a single source of truth. A web reader still sees the pipe snippets; splitting the doc per target would be the alternative and seems worse than that.

Verification

Built both packages locally (npx webpack --config webpack.dev.js, exit 0, no asset conflicts) and inspected the tarballs it packed:

  • uipath-coreipc-1.0.18.tgz and uipath-coreipc-web-1.0.18.tgz both contain package/README.md, package/readme-assets/* (5 images) and package/LICENSE
  • package/README.md is the client doc, starting at "# UiPath CoreIpc client for JavaScript"
  • the published node manifest reads "author": "UiPath", "license": "MIT", and repository/bugs/homepage all on UiPath/coreipc

Blast radius

Metadata and docs only — no client source, no version change. The tarball grows by ~53 KB of images. It takes effect at the next publish of the JS packages; versions already on GitHub Packages keep the old author and placeholder README.

Deliberately not in this PR

  • src/Clients/python/uipath-ipc/pyproject.toml:8 still attributes an individual (authors = [{ name = "Eduard Dumitru", ... }]); same class of fix, different package.
  • The manifest still says "name": "coreipc" / "version": "1.0.18" while ADO publishes @uipath/coreipc at the csproj version; the ticket asks about that drift, and it is a separate change.
  • The doc's "Notes for Contributors" section now ships to customers too. Trimming it would mean generating a second README at build time.
  • The .NET side's own metadata is unreviewed here.

🤖 Generated with Claude Code

…HDENS-7797]

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@lucarachiteanu
lucarachiteanu merged commit 66f2251 into master Sep 16, 2026
3 checks passed
@lucarachiteanu
lucarachiteanu deleted the fix/hdens-7797-js-package-author branch September 16, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants