Add GitHub Packages publishing to release workflow #13

Copilot · 2025-12-12T17:43:58Z

Plan: Add GitHub Packages Publishing Support

This task adds support for publishing the library to GitHub Packages in addition to npm, using GitHub Actions.

Checklist:

Summary of Changes:

Files Modified:

.github/workflows/release.yml - Enhanced to publish to both npm and GitHub Packages with rebuild
~~.npmrc~~ - Removed (not needed, uses registry-url in workflow instead)
README.md - Updated with installation and release documentation
vitest.config.js - Prettier formatting fix

Key Implementation Details:

✅ Token Permissions: Workflow already has packages: write permission
✅ Dual Publishing: Publishes to npm first, then rebuilds and publishes to GitHub Packages
✅ Conditional Logic: Only publishes to GitHub Packages when changesets actually publishes
✅ Authentication: Uses NPM_TOKEN for npm, GITHUB_TOKEN for GitHub Packages via registry-url
✅ No .npmrc needed: Registry configuration handled by actions/setup-node
✅ Rebuild before GitHub Packages: Ensures clean build for GitHub Packages
✅ Documentation: Clear instructions for users on both installation methods
✅ Security: No vulnerabilities detected by CodeQL scanner
✅ Formatting: All files pass Prettier checks

Original prompt

このライブラリをnpmだけでなくgithub packagesにもアップするようにしてほしい。
GitHub Actionsから行うこと。それから、トークン権限に注意。

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: yuki-js <[email protected]>

…on note Co-authored-by: yuki-js <[email protected]>

Copilot

Pull request overview

This PR enables dual-publishing of the @aokiapp/tlv package to both npm and GitHub Packages registries through GitHub Actions when releases are created.

Added GitHub Packages publishing step in the release workflow that triggers after successful npm publish
Created registry configuration file (.npmrc) for the @aokiapp scope
Updated documentation with installation instructions for both registries

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
`.npmrc`	Adds registry configuration pointing `@aokiapp` scope to GitHub Packages with token authentication
`.github/workflows/release.yml`	Extends release workflow to publish to GitHub Packages after npm publish, with separate Node.js setup steps for each registry
`README.md`	Documents installation instructions for both npm and GitHub Packages, including authentication requirements and automatic publishing behavior

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-12T18:02:03Z

.npmrc

+@aokiapp:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}


This .npmrc configuration will interfere with npm registry publishing. By setting the registry for the @aokiapp scope globally, all npm operations for @aokiapp/tlv (including the initial npm publish in the workflow) will attempt to use GitHub Packages registry instead of the npm registry.

This configuration should either be:

Removed entirely and rely on the registry-url parameter in actions/setup-node to configure the registry per step, or

Only applied conditionally during the GitHub Packages publish step (e.g., by creating the file dynamically in the workflow)

The workflow's registry-url parameter in actions/setup-node should be sufficient to configure the appropriate registry for each publish step without needing this file.

Suggested change

@aokiapp:registry=https://npm.pkg.github.com

//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}

Fixed in bd8307f - removed .npmrc file entirely. The workflow now relies solely on registry-url parameter in actions/setup-node to configure registries per step.

Copilot · 2025-12-12T18:02:04Z

.github/workflows/release.yml

+
+      - name: Publish to GitHub Packages
+        if: steps.changesets.outputs.published == 'true'
+        run: npm publish


The GitHub Packages publish step should rebuild the package before publishing. When npm run release executes (which runs npm run build && changeset publish), it builds the package for npm. However, when publishing to GitHub Packages, you're reusing the same built artifacts without rebuilding. This could be problematic if:

The build process embeds registry URLs or configuration

You want to ensure a clean build for each registry

There are any registry-specific modifications needed

Consider adding npm run build before the npm publish command, or ensuring that the build artifacts are registry-agnostic. For example:

run: npm run build && npm publish

Suggested change

run: npm publish

run: npm run build && npm publish

Fixed in bd8307f - added npm run build before npm publish in the GitHub Packages publish step to ensure a clean build.

Copilot · 2025-12-12T18:02:04Z

README.md

 npm run changelog     # Create changeset
 npm run version       # Update version
-npm run publish       # Publish to npm
+npm run publish       # Publish to npm (manual, or use GitHub Actions)


The comment is misleading - it suggests npm publish is "manual, or use GitHub Actions", but based on the workflow, npm publish is automated via the changesets action. The manual commands shown are for local development/testing, not the primary release method.

Consider clarifying this to make it clear that GitHub Actions is the primary/recommended method for releases, and manual publishing is only for special cases or local testing. For example: "Publish manually (for testing, otherwise use GitHub Actions)"

Suggested change

npm run publish # Publish to npm (manual, or use GitHub Actions)

npm run publish # Publish manually (for testing, otherwise use GitHub Actions)

Fixed in bd8307f - updated comment to clarify: "Publish manually (for testing, otherwise use GitHub Actions)"

yuki-js · 2025-12-12T18:08:56Z

https://github.com/AokiApp/tlv/actions/runs/20175243863/job/57922046535?pr=13 is failing @copilot

…h prettier Co-authored-by: yuki-js <[email protected]>

Copilot · 2025-12-12T18:12:49Z

https://github.com/AokiApp/tlv/actions/runs/20175243863/job/57922046535?pr=13 is failing @copilot

Fixed in bd8307f - the CI failure was due to Prettier formatting issues in README.md and vitest.config.js. Both files have been formatted and should now pass the checks.

Initial plan

094ce0e

Copilot AI assigned Copilot and yuki-js Dec 12, 2025

Copilot started work on behalf of yuki-js December 12, 2025 17:44 View session

Copilot AI and others added 3 commits December 12, 2025 17:47

Add GitHub Packages publishing support to release workflow

5a34342

Co-authored-by: yuki-js <[email protected]>

Update documentation for GitHub Packages installation

4616cac

Co-authored-by: yuki-js <[email protected]>

Address code review feedback: improve step names and add authenticati…

44b3c44

…on note Co-authored-by: yuki-js <[email protected]>

Copilot AI changed the title ~~[WIP] Add support for publishing to GitHub Packages~~ Add GitHub Packages publishing to release workflow Dec 12, 2025

Copilot AI requested a review from yuki-js December 12, 2025 17:52

Copilot finished work on behalf of yuki-js December 12, 2025 17:52

yuki-js marked this pull request as ready for review December 12, 2025 17:57

Copilot AI review requested due to automatic review settings December 12, 2025 17:57

Copilot started reviewing on behalf of yuki-js December 12, 2025 17:57 View session

Copilot AI reviewed Dec 12, 2025

View reviewed changes

Copilot started work on behalf of yuki-js December 12, 2025 18:09 View session

Fix review issues: remove .npmrc, add rebuild, fix README, format wit…

bd8307f

…h prettier Co-authored-by: yuki-js <[email protected]>

Copilot finished work on behalf of yuki-js December 12, 2025 18:16

yuki-js merged commit 18069a7 into main Dec 12, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add GitHub Packages publishing to release workflow #13

Add GitHub Packages publishing to release workflow #13

Uh oh!

Copilot AI commented Dec 12, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 12, 2025

Uh oh!

Copilot AI Dec 12, 2025

Uh oh!

Copilot AI Dec 12, 2025

Uh oh!

Copilot AI Dec 12, 2025

Uh oh!

Copilot AI Dec 12, 2025

Uh oh!

Copilot AI Dec 12, 2025

Uh oh!

yuki-js commented Dec 12, 2025

Uh oh!

Copilot AI commented Dec 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@aokiapp:registry=https://npm.pkg.github.com
		//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}

	npm run publish # Publish to npm (manual, or use GitHub Actions)
	npm run publish # Publish manually (for testing, otherwise use GitHub Actions)

Add GitHub Packages publishing to release workflow #13

Add GitHub Packages publishing to release workflow #13

Uh oh!

Conversation

Copilot AI commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plan: Add GitHub Packages Publishing Support

Checklist:

Summary of Changes:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

yuki-js commented Dec 12, 2025

Uh oh!

Copilot AI commented Dec 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Dec 12, 2025 •

edited

Loading