Skip to content

Add description and license to packages#204

Merged
cameronapak merged 2 commits intomainfrom
cp/demo-github-action-runners-test
Mar 27, 2026
Merged

Add description and license to packages#204
cameronapak merged 2 commits intomainfrom
cp/demo-github-action-runners-test

Conversation

@cameronapak
Copy link
Copy Markdown
Collaborator

Updates the package.json files for @youversion/platform-core, @youversion/platform-react-hooks, and @youversion/platform-react-ui to include a description and license field. This provides clearer context for each package.

CleanShot 2026-03-26 at 12 48 21@2x

Updates the `package.json` files for `@youversion/platform-core`,
`@youversion/platform-react-hooks`, and `@youversion/platform-react-ui`
to include a `description` and `license` field. This provides clearer
context for each package.
@cameronapak cameronapak marked this pull request as ready for review March 26, 2026 17:49
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 26, 2026

⚠️ No Changeset found

Latest commit: 71c599c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 26, 2026

Greptile Summary

This PR adds description and license metadata fields to all three published packages (@youversion/platform-core, @youversion/platform-react-hooks, @youversion/platform-react-ui), bringing them in line with standard npm publishing practices. It also resolves the pre-existing "license": "TBD" placeholder in the UI package, setting all three to the correct "Apache-2.0" SPDX identifier consistent with the root LICENSE file.

Key observations:

  • All packages remain at 1.22.0, satisfying the unified versioning requirement.
  • The "Apache-2.0" identifier correctly matches the Apache License 2.0 text at the repository root.
  • No changeset is included — given these are metadata-only changes with no API or behavioral impact, this is a reasonable omission.
  • packages/core and packages/hooks do not include a LICENSE file in their package directories, so the license text won't be bundled in the published tarball (a minor but notable gap for license compliance tooling).

Confidence Score: 5/5

Safe to merge — changes are metadata-only with no runtime impact.

All findings are P2 style suggestions. The core changes are correct: valid SPDX identifier, matching the root license, consistent versioning across packages. No functional, security, or behavioral issues are introduced.

packages/core/package.json and packages/hooks/package.json — consider adding LICENSE files to their directories for complete npm publishing compliance.

Important Files Changed

Filename Overview
packages/core/package.json Added description and license: "Apache-2.0" fields; no LICENSE file exists in the package directory to bundle with published output
packages/hooks/package.json Added description and license: "Apache-2.0" fields; same missing LICENSE file concern as packages/core
packages/ui/package.json Updated description to be more specific and resolved the pre-existing "license": "TBD" placeholder to "Apache-2.0"; "files" already lists "LICENSE" but no LICENSE file exists in this directory either (pre-existing)

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[npm publish] --> B{package has files field?}
    B -- Yes --> C[packages/ui\nfiles: dist, README.md, LICENSE]
    B -- No --> D[packages/core\nno files field → publish all]
    B -- No --> E[packages/hooks\nno files field → publish all]
    C --> F{LICENSE file exists\nin package dir?}
    D --> G{LICENSE file exists\nin package dir?}
    E --> H{LICENSE file exists\nin package dir?}
    F -- No --> I[pre-existing gap]
    G -- No --> J[license text not bundled]
    H -- No --> K[license text not bundled]
    style J fill:#ffe0b2
    style K fill:#ffe0b2
Loading

Reviews (2): Last reviewed commit: "Merge branch 'main' into cp/demo-github-..." | Re-trigger Greptile

@cameronapak cameronapak merged commit d891331 into main Mar 27, 2026
6 checks passed
@cameronapak cameronapak deleted the cp/demo-github-action-runners-test branch March 27, 2026 19:37
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