Skip to content

chore: enable automatic CHANGELOG generation via Changesets #945

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.

Sign up for GitHub

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

Open
kdaviduik wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: enable automatic CHANGELOG generation via Changesets #945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e76118
chore: enable automatic CHANGELOG generation via Changesets
kdaviduik Mar 9, 2026
1c79bb9
fix: add missing @changesets/changelog-github devDependency and CHANG…
kdaviduik Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
"changelog": false,
"changelog": ["@changesets/changelog-github", { "repo": "Shopify/buy-button-js" }],
"commit": false,
"fixed": [],
"linked": [],
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/npm-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ jobs:
- name: Update package version and remove changesets
if: env.changesets_found == 'true'
run: pnpm exec changeset version
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish to NPM
if: env.changesets_found == 'true'
Expand All @@ -69,6 +71,6 @@ jobs:
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git add package.json .changeset
git add package.json .changeset CHANGELOG.md
Copy link
Copy Markdown

@fredericoo fredericoo Mar 17, 2026

Choose a reason for hiding this comment

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

praise: good catch - changeset version was already generating CHANGELOG.md updates, but they were never staged in the commit step. this was a silent bug.

git commit -m "Update package version & delete changesets"
Copy link
Copy Markdown

@fredericoo fredericoo Mar 17, 2026

Choose a reason for hiding this comment

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

nit: the commit message says "Update package version & delete changesets" but now it also commits CHANGELOG.md changes. might be worth updating to reflect that - something like "Update package version, changelog & delete changesets". not fussed either way though.

Suggested change
git commit -m "Update package version & delete changesets"
git commit -m "Update package version, changelog & delete changesets"

git push
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changelog
### v3.0.6 (Unreleased)
### v3.0.6 (August 25, 2025)
Copy link
Copy Markdown

@fredericoo fredericoo Mar 17, 2026

Choose a reason for hiding this comment

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

praise: cheers for fixing the stale "(Unreleased)" label - v3.0.6 has been on npm since August.

- Add title attribute to iframes for improved accessibility ([#919](https://github.com/Shopify/buy-button-js/pull/919))

### v3.0.5 (July 2, 2025)
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
"@babel/plugin-transform-template-literals": "7.4.4",
"@babel/plugin-transform-typeof-symbol": "7.2.0",
"@babel/preset-typescript": "^7.27.1",
"@changesets/changelog-github": "^0.6.0",
Copy link
Copy Markdown

@fredericoo fredericoo Mar 17, 2026

Choose a reason for hiding this comment

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

non-blocking: @changesets/changelog-github pulls in node-fetch, dataloader, and dotenv as transitive deps. this is fine for a devDependency that only runs in CI, but worth noting - dotenv reads .env files from the working directory, so if one ever gets added to the repo it could affect the changeset version step. low risk, just flagging for awareness.

"@changesets/cli": "^2.28.1",
"@shopify/js-uploader": "https://github.com/Shopify/js-uploader.git",
"@types/jest": "^30.0.0",
Expand Down
66 changes: 66 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading