Updating @alza/react-ui

Development Workflow

When making changes to @alza/react-ui, you must create a changeset to document the change:

1. Make your changes

# Edit files in packages/alza-react-ui/...
git add .

2. Create a changeset

yarn changeset:add

This will prompt you to:

• Select @alza/react-ui package
• Choose version bump type:
  • major: Breaking changes (e.g., API changes, removed features)
  • minor: New features (backwards compatible)
  • patch: Bug fixes, documentation, small improvements
• Write a descriptive summary of the change

Tips for good changeset summaries:

• Be specific and user-focused
• Explain what changed and why
• Include migration steps for breaking changes
• Use clear language (not just “fix bug”)

3. Commit your changes WITH the changeset

git commit -m "feat(button): add loading animation"

Important: Commit the .changeset/*.md file with your changes!

Release Workflow (Stable Version)

1. Generate changelog and bump version

yarn version:prepare

This command:

• Consumes all changesets
• Updates CHANGELOG.md with new entries
• Bumps version in package.json
• Deletes consumed changeset files

2. REVIEW AND EDIT THE CHANGELOG

⚠️ Important: Open packages/alza-react-ui/CHANGELOG.md and:

• Review the new version section
• Edit entries to be more descriptive
• Add context, examples, or migration guides
• Reorganize by category (Breaking Changes, Features, Fixes)

3. Build the project

yarn workspace @alza/react-ui build

4. Commit the version bump

git add .
git commit -m "chore(release): @alza/react-ui v0.1.14"

5. Push to remote

git push

6. Publish to Azure Artifacts

yarn workspace @alza/react-ui npm publish

Build Development/Beta Version

For testing unreleased features:

1. Create a prerelease changeset

yarn changeset:add
# Select "patch" or "minor" depending on changes

2. Manually update version for development

# Edit packages/alza-react-ui/package.json
# Change version to include feature identifier
# Example: "0.1.14-feature-webcat-123-v.0"

3. Build and publish

yarn workspace @alza/react-ui build
yarn workspace @alza/react-ui npm publish

Note: Development versions should NOT be merged to main/dev branches.

Updating in apps

Update the version in package.json in the consuming app

{
    ...,
    "dependencies": {
        ...,
        // exact version - stable
        "@alza/react-ui": "0.0.3",
        // for testing purposes (use on betas, don't merge to dev)
        "@alza/react-ui": "0.0.3-feature-webcat-1234-v.0",
    }
 
}