Skip to content

fix: pack the NOTICE file - #2282

Open
justFU7 wants to merge 2 commits into
asyncapi:masterfrom
justFU7:fix/pack-notice-file
Open

fix: pack the NOTICE file#2282
justFU7 wants to merge 2 commits into
asyncapi:masterfrom
justFU7:fix/pack-notice-file

Conversation

@justFU7

@justFU7 justFU7 commented Aug 17, 2026

Copy link
Copy Markdown

Description

The repository has a NOTICE file at its root, but it has never reached the published package.

npm always packs README and LICENSE from the package root whatever files says, which is why
those two ship even though files names neither. NOTICE is not on that automatic list, so it needs an
explicit entry - and it does not have one.

Evidence from the published artifact

@asyncapi/cli@6.0.2 packs 267 entries. Its root level is:

$ curl -sLO https://registry.npmjs.org/@asyncapi/cli/-/cli-6.0.2.tgz
$ tar tzf cli-6.0.2.tgz | grep -E "^package/[^/]+$"
package/LICENSE
package/oclif.manifest.json
package/package.json
package/README.md
package/openapi.yaml

No NOTICE.

Why it matters

Apache-2.0 section 4(d) puts the obligation on whoever redistributes the work: if the distribution
includes a NOTICE, the attribution notices in it have to be carried along. Anyone repackaging
@asyncapi/cli - a Docker image, a vendored bundle, a downstream CLI - only ever receives the npm
tarball, so today they have no way to comply. Shipping the file is what makes that possible.

Changes

One line: "/NOTICE" added to the files array. No behaviour change, no new dependency, nothing else
touched.

Verifying

npm pack --dry-run

NOTICE now appears in the pack listing.

The published tarball has never contained it, so downstream redistributors cannot
carry the attribution notices Apache-2.0 section 4(d) asks them to preserve.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@changeset-bot

changeset-bot Bot commented Aug 17, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0b1d9b7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@asyncapi/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Triage

Development

Successfully merging this pull request may close these issues.

1 participant