npm - @khester/create-dynamics-app - Versions diffs - 1.1.0 → 2.1.0 - Mend

@khester/create-dynamics-app 1.1.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (210) hide show

package/templates/dynamics-365-starter/docs/team-standards/development-workflows.md DELETED Viewed

@@ -1,727 +0,0 @@
-# Development Workflows for Mixed Teams
-## Overview
-This document defines standardized development workflows for teams using both Windows and Mac
-platforms, ensuring consistent processes and deliverables regardless of the developer's operating
-system.
-## Table of Contents
-1. [Daily Development Workflow](#daily-development-workflow)
-2. [Feature Development Process](#feature-development-process)
-3. [Code Review Standards](#code-review-standards)
-4. [Testing Workflows](#testing-workflows)
-5. [Deployment Procedures](#deployment-procedures)
-6. [Emergency Response](#emergency-response)
-7. [Platform-Specific Considerations](#platform-specific-considerations)
-## Daily Development Workflow
-### 🌅 Morning Routine (All Platforms)
-#### 1. Environment Sync
-```bash
-# All platforms - same commands
-git pull origin develop
-npm install  # In case dependencies changed
-npm run build:dev  # Ensure clean build
-```
-#### 2. Platform-Specific Health Check
-**Windows Developers:**
-```powershell
-# Daily environment validation
-.\deployment\scripts\validate-setup.ps1 -Quiet
-# Check for PowerShell module updates
-Get-Module Microsoft.PowerApps* -ListAvailable | Format-Table Name, Version
-# Test deployment connection
-.\deployment\scripts\test-connection.ps1 -Environment dev
-```
-**Mac Developers:**
-```bash
-# Daily environment validation
-./deployment/scripts/validate-setup.sh --quiet
-# Check for tool updates
-brew outdated
-# Test deployment connection
-./deployment/scripts/test-connection.sh dev
-```
-### 🔄 Development Loop
-#### 1. Start Development Session
-```bash
-# All platforms - same workflow
-git checkout develop
-git pull origin develop
-git checkout -b feature/your-feature-name
-# Start development server
-npm run dev
-```
-#### 2. Iterative Development
-**Code → Test → Commit Cycle:**
-```bash
-# Make changes to code
-code src/components/YourComponent.tsx
-# Run quality checks (same on all platforms)
-npm run lint
-npm run typecheck
-npm run test
-# Commit changes
-git add .
-git commit -m "feat(component): add new feature functionality"
-```
-#### 3. Platform Testing
-Before pushing changes, test on your platform:
-**Windows:**
-```powershell
-# Build and test locally
-npm run build:dev
-.\deployment\scripts\deploy.ps1 -Environment dev -DryRun
-```
-**Mac:**
-```bash
-# Build and test locally
-npm run build:dev
-./deployment/scripts/deploy.sh dev --dry-run
-```
-### 🌆 End-of-Day Routine
-#### Push Changes
-```bash
-# Final quality check
-npm run quality
-# Push to remote
-git push origin feature/your-feature-name
-# Create draft PR for tomorrow's review
-gh pr create --draft --title "WIP: Your feature description"
-```
-#### Status Update
-Update team on platform-specific findings:
-- Any Windows-specific issues encountered
-- Mac-specific optimizations discovered
-- Cross-platform compatibility notes
-## Feature Development Process
-### 🚀 Feature Kickoff
-#### 1. Architecture Discussion
-**Cross-Platform Considerations:**
-- Will this feature require platform-specific deployment steps?
-- Are there any Windows vs Mac development tool differences?
-- Do we need to update both .ps1 and .sh scripts?
-- Are there platform-specific testing requirements?
-#### 2. Technical Design
-**Platform Impact Assessment:**
-```markdown
-## Platform Compatibility Checklist
-### Development Impact
-- [ ] Requires new development tools or dependencies
-- [ ] Uses file system operations (ensure cross-platform paths)
-- [ ] Modifies build or deployment processes
-- [ ] Adds new environment variables or configuration
-### Testing Impact
-- [ ] Platform-specific testing scenarios
-- [ ] Cross-platform validation requirements
-- [ ] Performance differences between platforms
-- [ ] UI/UX variations between platforms
-### Documentation Impact
-- [ ] Updates to Windows quick start guide
-- [ ] Updates to Mac quick start guide
-- [ ] New troubleshooting scenarios
-- [ ] Changes to team workflows
-```
-### 🏗️ Implementation Phase
-#### 1. Development Standards
-**File Path Handling:**
-```typescript
-// ❌ Wrong - platform-specific
-const configPath =
-  process.platform === 'win32' ? 'config\\environments\\dev.json' : 'config/environments/dev.json';
-// ✅ Correct - cross-platform
-import path from 'path';
-const configPath = path.join('config', 'environments', 'dev.json');
-```
-**Environment Variables:**
-```typescript
-// ✅ Platform-agnostic configuration
-const config = {
-  apiUrl: process.env.D365_API_URL || 'https://default.api.url',
-  clientId: process.env.D365_CLIENT_ID,
-  environment: process.env.NODE_ENV || 'development',
-};
-```
-#### 2. Cross-Platform Testing
-**During Development:**
-```bash
-# Test build on your platform
-npm run build:dev
-# Test key functionality
-npm run test:integration
-# Validate deployment preparation
-npm run deploy:dev --dry-run
-```
-**Before PR Submission:**
-- ✅ Code builds successfully on your platform
-- ✅ All tests pass locally
-- ✅ Deployment dry-run succeeds
-- ✅ Documentation updated for any platform-specific changes
-### 🔄 Feature Integration
-#### 1. Pull Request Creation
-**PR Template for Cross-Platform Features:**
-```markdown
-## Description
-[Feature description]
-## Cross-Platform Testing
-- [ ] Tested on Windows (PowerShell deployment)
-- [ ] Tested on Mac (Bash deployment)
-- [ ] CI/CD pipeline passes on both platforms
-- [ ] Documentation updated for both platforms
-## Platform-Specific Changes
-- [ ] Updated .ps1 scripts (if applicable)
-- [ ] Updated .sh scripts (if applicable)
-- [ ] Updated Windows quick start guide
-- [ ] Updated Mac quick start guide
-## Deployment Impact
-- [ ] No changes to deployment process
-- [ ] Minor deployment changes (documented)
-- [ ] Major deployment changes (team approval required)
-## Screenshots/Videos
-[Include platform-specific screenshots if UI changes]
-```
-#### 2. Review Assignment
-**Automatic Reviewer Assignment:**
-- At least one Windows developer
-- At least one Mac developer
-- Technical lead or senior developer
-- DevOps engineer (if deployment changes)
-## Code Review Standards
-### 🔍 Cross-Platform Review Checklist
-#### General Code Quality
-- [ ] **TypeScript compliance** - Strict mode, proper typing
-- [ ] **Code style** - ESLint and Prettier compliance
-- [ ] **Error handling** - Comprehensive error scenarios
-- [ ] **Testing** - Unit tests and integration tests
-- [ ] **Documentation** - Code comments and README updates
-#### Platform Compatibility
-- [ ] **File paths** - Uses path.join() instead of hardcoded separators
-- [ ] **Environment variables** - No platform-specific assumptions
-- [ ] **Command execution** - Cross-platform compatible if applicable
-- [ ] **Dependencies** - Available on both Windows and Mac
-- [ ] **Build process** - Identical results on both platforms
-#### Deployment Scripts
-- [ ] **PowerShell (.ps1)** - Updated if deployment changes
-- [ ] **Bash (.sh)** - Updated if deployment changes
-- [ ] **Error handling** - Platform-appropriate error messages
-- [ ] **Parameter compatibility** - Same functionality, different syntax
-- [ ] **Validation** - Both scripts produce identical results
-### 👀 Review Process
-#### 1. Technical Review
-**Windows Reviewer Responsibilities:**
-- Validate PowerShell scripts and Windows-specific paths
-- Test on Windows development environment
-- Verify Windows deployment procedures work
-- Check Windows-specific documentation accuracy
-**Mac Reviewer Responsibilities:**
-- Validate Bash scripts and Unix-style paths
-- Test on Mac development environment
-- Verify Mac deployment procedures work
-- Check Mac-specific documentation accuracy
-#### 2. Cross-Platform Validation
-**Required Checks:**
-```bash
-# Reviewer tests (adapt commands to their platform)
-git checkout feature/branch-name
-npm install
-npm run build:dev
-npm run quality
-npm run deploy:dev --dry-run
-```
-**Validation Questions:**
-- Does the feature work identically on both platforms?
-- Are error messages appropriate for each platform?
-- Do deployment results match across platforms?
-- Is documentation accurate for both setups?
-#### 3. Approval Process
-**Approval Requirements:**
-- ✅ **Technical approval** from Windows developer
-- ✅ **Technical approval** from Mac developer
-- ✅ **CI/CD pipeline** passes on both platforms
-- ✅ **Architecture approval** from technical lead (if significant changes)
-- ✅ **Documentation review** (if docs changed)
-## Testing Workflows
-### 🧪 Local Testing Standards
-#### Unit Testing (All Platforms)
-```bash
-# Same commands for all developers
-npm run test               # Run all tests
-npm run test:watch         # Watch mode for development
-npm run test:coverage      # Generate coverage report
-npm run test:specific -- MyComponent  # Test specific component
-```
-#### Integration Testing
-**Windows Integration Tests:**
-```powershell
-# Test PowerShell integration
-.\deployment\scripts\test-integration.ps1 -Environment dev
-# Test Windows-specific features
-npm run test:integration:windows
-```
-**Mac Integration Tests:**
-```bash
-# Test Bash integration
-./deployment/scripts/test-integration.sh dev
-# Test Mac-specific features
-npm run test:integration:mac
-```
-### 🔄 CI/CD Testing
-#### Pipeline Testing Strategy
-**Multi-Platform Pipeline:**
-```yaml
-# Simplified CI/CD strategy
-Build: Linux (fastest)
-Unit Tests: Linux (consistent environment)
-Integration: Both Windows and Linux
-Deploy Test: Platform-specific (Windows PowerShell, Linux Bash)
-Cross-Platform: Validation on both platforms
-```
-#### Pre-Merge Validation
-**Automated Checks:**
-- ✅ Unit tests pass on Linux
-- ✅ Integration tests pass on Windows
-- ✅ Integration tests pass on Linux
-- ✅ Build artifacts are identical
-- ✅ Deployment dry-run succeeds on both platforms
-**Manual Validation:**
-- ✅ Code review from both platform developers
-- ✅ Feature testing on both platforms
-- ✅ Documentation accuracy verification
-## Deployment Procedures
-### 🚀 Deployment Workflow
-#### 1. Pre-Deployment Validation
-**All Platforms:**
-```bash
-# Validate code quality
-npm run quality
-# Build production bundle
-npm run build:prod
-# Run comprehensive tests
-npm run test:all
-```
-**Platform-Specific Validation:**
-**Windows:**
-```powershell
-# Validate deployment environment
-.\deployment\scripts\validate-setup.ps1
-# Test deployment process
-.\deployment\scripts\deploy.ps1 -Environment dev -DryRun
-```
-**Mac:**
-```bash
-# Validate deployment environment
-./deployment/scripts/validate-setup.sh
-# Test deployment process
-./deployment/scripts/deploy.sh dev --dry-run
-```
-#### 2. Environment Deployment
-**Development Environment:**
-```bash
-# Any team member can deploy to dev
-npm run deploy:dev
-# Platform-specific commands also work:
-# Windows: .\deployment\scripts\deploy.ps1 -Environment dev
-# Mac:     ./deployment/scripts/deploy.sh dev
-```
-**Test Environment:**
-```bash
-# Requires approval, any platform can execute
-npm run deploy:test
-# Automated through CI/CD on main branch merge
-```
-**Production Environment:**
-```bash
-# Requires multiple approvals
-npm run deploy:prod
-# Must be tested on both platforms in CI/CD
-# Manual approval gate in pipeline
-```
-#### 3. Post-Deployment Validation
-**Health Checks (All Platforms):**
-```bash
-# Universal health check
-npm run health-check
-# Platform-specific validation:
-# Windows: .\deployment\scripts\health-check.ps1 -Environment prod
-# Mac:     ./deployment/scripts/health-check.sh prod
-```
-**Monitoring Setup:**
-```bash
-# Cross-platform monitoring
-npm run setup-monitoring
-# Platform-specific detailed monitoring
-# Windows: .\deployment\scripts\setup-monitoring.ps1
-# Mac:     ./deployment/scripts/setup-monitoring.sh
-```
-### 🔄 Rollback Procedures
-#### Emergency Rollback
-**Windows:**
-```powershell
-# Emergency rollback
-.\deployment\scripts\rollback.ps1 -Environment prod -BackupFile "backup-20240315-143022.zip"
-# Validation
-.\deployment\scripts\health-check.ps1 -Environment prod
-```
-**Mac:**
-```bash
-# Emergency rollback
-./deployment/scripts/rollback.sh prod backup-20240315-143022.tar.gz
-# Validation
-./deployment/scripts/health-check.sh prod
-```
-**Cross-Platform Coordination:**
-- Notify team immediately in #dynamics-emergency channel
-- Provide platform-agnostic status updates
-- Document rollback reason and resolution steps
-## Emergency Response
-### 🚨 Incident Response Workflow
-#### 1. Issue Detection
-**Monitoring Alerts:**
-- Automated monitoring detects issue
-- Alerts sent to #dynamics-alerts channel
-- On-call engineer (any platform) responds
-**Manual Detection:**
-- Team member discovers issue
-- Report in #dynamics-emergency channel
-- Include platform information in report
-#### 2. Initial Assessment
-**Information Gathering:**
-```bash
-# Gather system information (adapt to platform)
-# Windows: Get-ComputerInfo | Select-Object WindowsProductName, TotalPhysicalMemory
-# Mac:     system_profiler SPSoftwareDataType SPHardwareDataType
-# Check application health
-npm run health-check
-# Review recent deployments
-git log --oneline -10
-```
-**Platform-Specific Diagnostics:**
-**Windows:**
-```powershell
-# Check Windows-specific issues
-Get-EventLog -LogName Application -Source "YourApp" -Newest 10
-.\deployment\scripts\diagnose.ps1 -Environment prod
-```
-**Mac:**
-```bash
-# Check Mac-specific issues
-tail -n 100 /var/log/system.log | grep YourApp
-./deployment/scripts/diagnose.sh prod
-```
-#### 3. Resolution Process
-**Escalation Levels:**
-1. **Self-resolve** (15 minutes) - Individual team member
-2. **Team assistance** (30 minutes) - Platform experts help
-3. **Technical lead** (45 minutes) - Architecture-level decisions
-4. **Emergency rollback** (60 minutes) - Return to last known good state
-**Cross-Platform Collaboration:**
-- Share diagnostics in team channel
-- Use screen sharing for real-time troubleshooting
-- Document platform-specific resolution steps
-- Test resolution on both platforms before closing
-### 📋 Post-Incident Process
-#### 1. Post-Mortem
-**Required Analysis:**
-- Root cause identification
-- Platform-specific contributing factors
-- Cross-platform impact assessment
-- Prevention strategies for both platforms
-#### 2. Process Improvement
-**Documentation Updates:**
-- Update troubleshooting guides for both platforms
-- Improve monitoring and alerting
-- Enhance deployment validation
-- Strengthen team training on platform differences
-## Platform-Specific Considerations
-### 🖥️ Windows Development
-#### Unique Strengths
-- **PowerShell ISE/VS Code** - Rich debugging experience
-- **PowerApps CLI** - Native Dynamics 365 tooling
-- **Azure DevOps** - Seamless integration
-- **Enterprise tooling** - Native Windows admin tools
-#### Common Challenges
-- **Execution policies** - PowerShell script restrictions
-- **Path separators** - Backslash vs forward slash
-- **Case sensitivity** - Different from Linux/Mac
-- **Module dependencies** - PowerShell module management
-#### Best Practices
-```powershell
-# Always check execution policy
-Get-ExecutionPolicy
-Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
-# Use PowerShell-native paths
-$configPath = Join-Path $ProjectRoot "config\environments\dev.json"
-# Handle errors properly
-try {
-    Invoke-RestMethod -Uri $ApiUrl -Method GET
-} catch {
-    Write-Error "API call failed: $($_.Exception.Message)"
-}
-```
-### 🍎 Mac Development
-#### Unique Strengths
-- **Terminal/iTerm2** - Powerful command-line experience
-- **Homebrew** - Excellent package management
-- **Docker** - Native container development
-- **Open source tools** - Better compatibility with Linux tooling
-#### Common Challenges
-- **Case sensitivity** - File system differences
-- **Permissions** - Script execution permissions
-- **Tool installation** - Different package managers
-- **Path handling** - Different from Windows
-#### Best Practices
-```bash
-# Always make scripts executable
-chmod +x deployment/scripts/*.sh
-# Use proper path handling
-config_path="$PROJECT_ROOT/config/environments/dev.json"
-# Handle errors properly
-set -euo pipefail  # Exit on error, undefined vars, pipe failures
-# Check dependencies
-command -v jq >/dev/null 2>&1 || { echo "jq required but not installed"; exit 1; }
-```
-### 🤝 Cross-Platform Harmony
-#### Shared Strengths
-- **Node.js ecosystem** - Identical runtime environment
-- **VS Code** - Consistent development experience
-- **Git workflows** - Same version control processes
-- **TypeScript** - Same language and tooling
-#### Unified Approaches
-```typescript
-// Platform-agnostic file operations
-import fs from 'fs/promises';
-import path from 'path';
-// Read configuration
-const configPath = path.join(process.cwd(), 'config', 'environments', `${env}.json`);
-const config = JSON.parse(await fs.readFile(configPath, 'utf8'));
-// Environment detection
-const isWindows = process.platform === 'win32';
-const scriptExtension = isWindows ? '.ps1' : '.sh';
-const scriptCommand = isWindows ? 'powershell' : 'bash';
-```
----
-These development workflows ensure that Windows and Mac team members can work together effectively
-while leveraging platform-specific strengths and maintaining consistent deliverables across the
-entire team.