@realwork-labs/rwl-test

Shared dependencies across RealWork Labs.

Installation

# For team members only - requires authentication
npm install @realwork-labs/rwl-test

Development Setup

1. Clone the repository

git clone https://github.com/RealWork-Labs/rwl-test.git
cd rwl-test
npm install

2. Create a .npmrc in project root:

@realwork-labs:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

Package Configuration

This package is:

• Private and scoped to @realwork-labs
• Requires authentication to install
• Published via GitHub Actions on tag creation
• Uses conventional commits for versioning

Scripts

npm run build        # Build the package
npm run clean        # Clean dist directory
npm run lint         # Run linter
npm run lint:fix     # Fix linting issues
npm run format       # Check formatting
npm run format:fix   # Fix formatting
npm run release      # Create new version (changelog, tag)

Publishing Workflow

Local Development

1. Create feature branch from main

git checkout -b feature/your-feature

2. Make changes following conventional commits:

git commit -m "feat: add new feature"
git commit -m "fix: resolve bug"

3. Push branch and create PR

git push origin feature/your-feature

4. After PR approval and merge to main:

git checkout main
git pull
npm run release

CI/CD Publishing

• GitHub Actions automatically publishes when a new tag is pushed
• Requires NPM_TOKEN secret in GitHub repository
• Only publishes from main branch
• Runs tests and builds before publishing

Branch Strategy

main (protected)
  └── feature/your-feature
  └── fix/your-bugfix

• All changes via feature/fix branches
• PRs require approval
• Squash merge to main
• Auto-publish on tag creation

Team Access

Adding new team members:

npm access restricted @realwork-labs/rwl-test
npm owner add <team-member-username> @realwork-labs/rwl-test

Version Control

We use:

• Conventional commits for clear history
• standard-version for changelog generation
• Protected main branch
• Squash merging for clean history

Publishing Checklist

Before publishing:

• [ ] All tests pass
• [ ] Linting passes
• [ ] PR approved
• [ ] Changes documented
• [ ] Version bumped
• [ ] Changelog updated