Skip to content

Add symlink script for local package testing#454

Open
brionmario wants to merge 1 commit intoasgardeo:mainfrom
brionmario:fix-symlinking
Open

Add symlink script for local package testing#454
brionmario wants to merge 1 commit intoasgardeo:mainfrom
brionmario:fix-symlinking

Conversation

@brionmario
Copy link
Copy Markdown
Member

@brionmario brionmario commented Apr 12, 2026

Purpose

This pull request introduces a new workflow for testing local package changes in external projects by providing a symlink script. This script automates building packages, patching internal dependencies, and generating override snippets for different package managers. The documentation is updated to reflect this improved process, replacing the old manual npm link instructions.

The most important changes are:

Developer Experience Improvements

  • Added a new symlink script to package.json that runs scripts/symlink.js, automating the preparation of local packages for external linking.
  • Introduced scripts/symlink.js, which builds all packages, replaces catalog: and workspace:* dependencies with resolvable versions or file paths, and prints ready-to-paste override snippets for pnpm, npm, and Yarn.

Documentation Updates

  • Updated the "Test your translation" section in CONTRIBUTING.md to describe the new symlink workflow, replacing the previous manual npm link instructions with a streamlined, script-based approach.
  • Clarified the documentation navigation and section headings to reference the new symlink-based workflow.

Related Issues

Related PRs

  • N/A

Checklist

  • Followed the CONTRIBUTING guidelines.
  • Manual test round performed and verified.
  • Documentation provided. (Add links if there are any)
  • Unit tests provided. (Add links if there are any)

Security checks

@asgardeo-github-bot
Copy link
Copy Markdown

⚠️ No Changeset found

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.

Refer Release Documentation to learn how to add a changeset.

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.

Limitations in Testing Local Packages with pnpm Due to Symlink and Dependency Resolution Issues

2 participants