Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix changelogs.xyz page for @changesets/cli by adding CHANGELOG.md to package.json’s files array #1309

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

acusti
Copy link

@acusti acusti commented Feb 15, 2024

https://changelogs.xyz/@changesets/cli (linked to from the “Explore Changelog” badge at the top of the main readme) currently can”t find a changelog for @changesets/cli and points to https://unpkg.com/browse/@changesets/cli@2.27.1/ as the source it is browsing to find the file

UNPKG doesn’t list CHANGELOG.md because it is listing the distributed files from published versions of the package, and CHANGELOG.md isn’t currently included because it isn’t in the package.json files array.

i believe that adding it to package.json’s files (and publishing a new version of the package) will fix the issue, though it would be tricky for me to confirm that on my own. either way, the changelog seems like it could be a useful thing to distribute with the package so that package consumers can refer to it if the need should arise.

https://changelogs.xyz/@changesets/cli (linked to from the “Explore Changelog” badge at the top of the main readme) currently can”t find a changelog for @changesets/cli and points to https://unpkg.com/browse/@changesets/cli@2.27.1/ as the source it is browsing to find the file
• UNPKG doesn’t list CHANGELOG.md because it is listing the distributed files from published versions of the package, and CHANGELOG.md isn’t currently included because it isn’t in the package.json files array
Copy link

changeset-bot bot commented Feb 15, 2024

⚠️ No Changeset found

Latest commit: 378bff5

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

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

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.

None yet

1 participant