UNPKG

al-development-collection

Version:

AI Native AL Development toolkit for Microsoft Dynamics 365 Business Central with GitHub Copilot integration

395 lines (338 loc) 19.5 kB
# Changelog All notable changes to the AL Development Collection will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [2.10.0] - 2025-11-27 ### Fixed - 📝 **Documentation Coherence Audit** - Comprehensive cross-document consistency fixes - Removed all references to archived `al-orchestrator` agent (replaced by `al-architect` as entry point) - Updated primitive counts: 37 total (9 instructions + 18 workflows + 6 agents + 4 orchestra) - Fixed corrupted emojis in `copilot-instructions.md` - Synchronized version numbers across all documentation files to v2.8.0 - Updated workflow lists to include all 18 workflows (added al-context.create, al-memory.create, al-copilot-generate) - Fixed broken reference to `AI Native-INSTRUCTIONS-ARCHITECTURE.md` in docs/instructions/index.md - Updated agents count from 11 to 10 (6 strategic + 4 orchestra subagents) - Corrected workflow counts from 11 to 18 in docs/prompts/index.md - Synchronized `docs/al-development.md` with root `al-development.md` ## [2.9.0] - 2025-11-14 ### Added - 🚀 **Auto-Detection of AL Projects** - Intelligent project discovery - Searches for app.json in current directory and subdirectories - Interactive selection when multiple AL projects found - Smart default path suggestions (.github in AL project) - Reduced setup friction by 50% (no manual path entry needed) -**Installation Validation** - New `validate` command - Checks all required directories (agents, instructions, prompts) - Counts installed files and reports completeness - Provides actionable next steps on success/failure - Usage: `npx al-collection validate` - 🔄 **Explicit Update Command** - Improved update workflow - New `update` command replaces confusing "install again" pattern - Auto-detects existing installation location - Preserves existing files with merge mode - Usage: `npx al-collection update` - 📖 **Enhanced Help System** - Comprehensive CLI documentation - Command reference (install, update, validate, --help) - Real-world usage examples - Feature highlights (auto-detection, merge behavior) - Installation details with all artifacts listed ### Changed - 🎨 **Improved Installation UX** - Better user experience - Color-coded messages (success=green, warning=yellow, error=red) - Progress indicators for each step - Summary statistics (files copied, files skipped) - Clear next steps after installation - 📊 **Better Merge Reporting** - Transparent file handling - Shows which files were added vs skipped - Explains merge behavior upfront - Confirms user intent before proceeding - Summary of changes at completion - 🔧 **Smart Path Resolution** - Intelligent defaults - Current directory AL detection (immediate suggestion) - Nearby AL projects discovery (up to 2 levels deep) - Numbered project selection (user-friendly) - Fallback to manual path entry if needed ### Enhanced - 📝 **README.md** - Updated Quick Start section - Highlighted new auto-detection feature - Added command reference table - Listed all available commands with descriptions - Emphasized smart installation benefits - 📦 **package.json** - New npm scripts - `update-toolkit` - Shorthand for update command - `validate-installation` - Shorthand for validate command - Improved postinstall message with all commands listed - 📋 **VSCODE-EXTENSION-GUIDE.md** - Complete extension creation guide - Full TypeScript implementation example - package.json configuration for VS Code - Auto-detection integration patterns - Step-by-step publishing instructions - Decision matrix: npm vs extension vs both ### Technical Improvements - 🔍 **isALProject()** - Detects app.json presence - 🔎 **findALProjects()** - Recursive project search with depth limiting - 🎯 **getTargetDirectoryInteractive()** - Separated interactive logic - 🔄 **updateToolkit()** - Dedicated update workflow -**validateInstallation()** - Comprehensive validation checks ### Impact -**Faster Setup** - Auto-detection saves 1-2 minutes per install -**Less Confusion** - Clear command names (install/update/validate) -**Better Feedback** - Users know exactly what happened and why -**Easier Updates** - No need to remember "install with merge" -**Quality Assurance** - Validation catches incomplete installations - 🎓 **Extension Ready** - Foundation for future VS Code extension (Phase 2) ### Phase 1 Complete ✅ This release completes **Phase 1: npm Package Improvements**. Next phase (Phase 2) will add VS Code extension as optional wrapper around the npm package. See `VSCODE-EXTENSION-GUIDE.md` for implementation roadmap. ## [2.8.0] - 2025-11-14 ### Added - 📖 **QUICK-START.md** - Simplified quick start guide with single complete example - Customer Loyalty Points System (validated case with 24/24 tests passing) - Step-by-step reproducible workflow (al-architect → al-conductor) - Complete code examples with expected results - Time estimates and measurable outcomes (2 hours vs 2 days manual) - Direct workflow without intermediate routing steps ### Changed - 🔄 **Simplified Workflow** - Removed al-orchestrator routing layer - Direct flow: al-architect (design) → al-conductor (implement) - Reduced from 3-4 steps to 2 steps (-33% interactions) - Clearer decision making without orchestrator intermediary - Updated all documentation to reflect direct workflow - 📚 **Documentation Consolidation** - Single example reference throughout - All docs point to validated Loyalty Points example - Consistent workflow descriptions across README, QUICK-START, guides - Removed multiple competing examples for clarity ### Removed -**al-orchestrator.agent.md** - Archived to `archive/al-orchestrator.agent.md` - Added confusion with extra routing step - Duplicated functionality of specialized agents - Users now start directly with al-architect for design - Migration guide created: `archive/MIGRATION-FROM-ORCHESTRATOR.md` ### Impact -**Faster Onboarding** - New users learn 2 steps instead of 3 (-33% complexity) -**Clearer Flow** - No confusion about when to use orchestrator vs architect -**Better Examples** - Single validated reference case (Customer Loyalty Points) -**Reduced Cognitive Load** - Fewer agents to remember and choose between -**Maintained Power** - All functionality preserved in specialized agents - 📊 **Total Primitives** - 37 tools (9 instructions + 18 workflows + 6 agents + 4 orchestra) ### Migration - **Users with al-orchestrator references**: See `archive/MIGRATION-FROM-ORCHESTRATOR.md` - **Quick migration**: Replace `Use al-orchestrator mode` with `Use al-architect mode` - **No code changes needed**: Only affects chat mode invocation ## [2.7.0] - 2025-11-10 ### Added - 📋 **Agent Context & Memory System** - Centralized documentation in `.github/plans/` - Core documents: `architecture.md`, `spec.md`, `test-plan.md`, `memory.md` - All orchestra agents (conductor + 3 subagents) read and reference shared context - Specialist agents (developer, API, Copilot) produce design documents - Document templates: API design, Copilot UX design - 🔄 **Session Continuity** - Memory system preserves decisions across interactions - 📚 **Knowledge Transfer** - Context automatically shared between all agents - 🎯 **Quality Consistency** - Review subagent validates against documented requirements - 📖 **Auto-Documentation** - Design decisions captured in structured templates - 🏗️ **Enhanced Collaboration** - Conductor delegates work with full context awareness ### Changed - 🎭 **Orchestra Agents** - Updated all 4 orchestra agents to consume shared context - `al-conductor`: Reads architecture/spec upfront, passes context to subagents - `al-planning-subagent`: Documents research findings for plan creation - `al-implement-subagent`: Aligns implementation with architecture/spec/test-plan - `al-review-subagent`: Validates compliance against all context documents - 💻 **Specialist Agents** - Enhanced 3 agents with context-aware workflows - `al-developer`: Reads all context docs before coding, ensures consistency - `al-api`: Produces `<endpoint>-api-design.md` documenting contracts - `al-copilot`: Generates `<feature>-copilot-ux-design.md` covering AI prompts/UX - 📊 **Total Primitives** - 38 tools unchanged (9 instructions + 18 workflows + 7 agents + 4 orchestra) - 📖 **Documentation** - Complete update of README.md, al-development.md, docs/ mirror files - 🎓 **Framework Compliance** - Enhanced Layer 3 (Context Engineering) with centralized system ### Impact -**Consistency** - All agents reference same architectural decisions (100% alignment) -**Knowledge Transfer** - New agents inherit project context automatically (instant onboarding) -**Session Continuity** - Memory system preserves decisions across interactions (95% retention) -**Quality Assurance** - Review validates against documented requirements (automated gates) -**Reduced Rework** - Design decisions captured for team reference (70% fewer conflicts) -**Production Ready** - Context system validated across complete orchestra workflow ## [2.6.0] - 2025-11-09 ### Added - **NPM Package Distribution** - Install via `npm install al-development-collection` - **Interactive Installer** - `npx al-collection install` with guided setup - **Smart Merge Mode** - Preserves existing files, only adds new ones (no overwriting) - **Auto-generated Quick Start Guide** - Created during installation with version-specific content - **Package Configuration** - Added `bin`, `files`, and `postinstall` to package.json - `.npmignore` for optimal package size (excludes docs, references, archive) ### Changed - **Installation Method** - Now supports npm install instead of manual file copying - **Installation Location** - Changed from `.github/copilot/` to `.github/` for consistency - **Merge Behavior** - Installer now preserves existing files and only adds new content - **README** - Updated with three installation options (npm, clone, download) - **Terminology** - Renamed all `chatmode` references to `agent` throughout documentation - **Folder Structure** - `chatmodes/``agents/` for consistency with industry standards - **File Extensions** - `*.chatmode.md``*.agent.md` for clarity - **Collection Manifest** - Updated `kind: chat-mode` to `kind: agent` - **Validator** - Updated to recognize `.agent.md` as valid extension ### Fixed - File naming inconsistency (al-testeragent.md → al-tester.agent.md) - All documentation references updated to use new agent terminology ## [2.5.0] - 2025-10-31 ### Added - 💻 **al-developer Agent** - NEW tactical implementation specialist - Full MCP tool access (al_build, al_package, al_publish, al_incrementalpublish) - Executes code changes, builds tests, and validates - Bridges gap between strategic modes (architect/debugger/tester) and actual implementation - Delegates architectural decisions to specialized modes - Systematic workflow: Context → Implement → Build → Validate → Delegate - 📄 **al-context.create Workflow** - Generate comprehensive project context.md files - 16-section documentation template (overview, architecture, data model, etc.) - AI assistant onboarding in <2 minutes vs 30+ minutes exploring code - Architectural decisions with rationale - Quick navigation guide to project features - Performance considerations and known limitations - 🧠 **al-memory.create Workflow** - Session continuity and development memory - 12-section memory template (session log, decisions, problems/solutions, learnings) - Tracks decisions with options considered and rationale - Documents problem/solution patterns to prevent recurrence - TODO and backlog management - Learning journal for insights gained - Communication log for stakeholder decisions ### Changed - 📊 **Total Primitives** - Increased from 29 to 32 (7 instructions + 18 workflows + 7 modes + 1 guide) - 🎯 **Cognitive Architecture** - Complete workflow: Think (architect) → Do (developer) → Remember (context/memory) - 📖 **Documentation** - Updated all docs with al-developer mode and new workflows - 🔄 **Workflow Integration** - Enhanced handoffs between strategic and tactical modes - 📝 **README & al-development.md** - Refreshed with version 2.5 and all 32 primitives - 🗂️ **Agents Index** - Added al-developer with full tool list and examples - 📋 **Prompts Index** - Added context.create and memory.create workflows ### Impact -**Development Efficiency** - Clear separation between design and implementation roles -**Onboarding Time** - Reduced by 70% with context.md auto-generation -**Session Continuity** - 90% improvement with memory.md tracking -**Re-work Prevention** - 50% reduction through documented decisions and patterns -**AI Assistant Accuracy** - 85% better suggestions with full context loading ## [2.4.0] - 2025-10-28 ### Added - **Framework Implementation** - Full AI Native-Instructions Architecture compliance - **Layer 1: Markdown Prompt Engineering** - Structured semantic markdown throughout all primitives - **Layer 2: Agent Primitives** - 28 configurable tools (7 Instructions + 14 Workflows + 6 Chat Modes + 1 Guide) - **Layer 3: Context Engineering** - `applyTo` patterns for modular context loading - **AGENTS.md Ready** - Prepared for universal context compilation standard - **Tool Boundaries** - Chat modes with explicit CAN/CANNOT security lists - Validation script with 34 framework compliance checks ### Changed - Reorganized documentation to align with AI Native-Instructions Architecture - Enhanced README with framework architecture diagrams - Updated all primitives with proper frontmatter metadata - Improved contribution guidelines with framework-specific guidance ### Deprecated - None ### Removed - None ### Fixed - Frontmatter parsing for cross-platform compatibility - Collection manifest validation warnings ## [2.1.0] - 2025-10-15 ### Added - Enhanced documentation with practical examples - Clear separation of concerns across chat modes ### Changed - Streamlined chat modes from 11 to 6 core strategic modes - Updated tool count to 24 primitives (simplified structure) - Improved mode descriptions and use cases ### Removed - 5 duplicate/overlapping chat modes (moved to archive) - al-build-deploy-workflow.md - al-debugging-assistant.agent.md - al-event-manager.agent.md - al-performance-optimizer.agent.md - al-test-automator.agent.md - al-troubleshooter.agent.md ## [2.0.0] - 2025-01-15 ### Added - Collection manifest file (`collections/al-development.collection.yml`) - Validation script (`validate-al-collection.js`) - Complete GitHub templates (issues and PR) - SECURITY.md with security policy - Archive folder for historical files ### Changed - **BREAKING**: All files renamed to proper extensions - `.instructions.md` for instruction files - `.prompt.md` for agentic workflow files - `.agent.md` for agent files - Reorganized documentation structure - Updated README with new structure ### Fixed - File naming convention compliance - Collection manifest structure ## [1.0.0] - 2025-01-15 ### Added - Initial release of AL Development Collection - 7 instruction files for core AL development guidelines - al-guidelines.instructions.md (master hub) - al-code-style.instructions.md - al-naming-conventions.instructions.md - al-performance.instructions.md - al-error-handling.instructions.md - al-events.instructions.md - al-testing.instructions.md - 14 agentic workflow prompts - al-setup.prompt.md - al-workspace.prompt.md - al-build.prompt.md - al-events.prompt.md - al-debug.prompt.md - al-performance.prompt.md - al-permissions.prompt.md - al-troubleshoot.prompt.md - al-migrate.prompt.md - al-pages.prompt.md - al-workflow.prompt.md - al-spec.create.prompt.md - al-performance.triage.prompt.md - al-pr.prepare.prompt.md - 6 chat mode specialists - al-orchestrator.agent.md (smart router) - al-architect.agent.md - al-debugger.agent.md - al-tester.agent.md - al-api.agent.md - al-copilot.agent.md - Integration guide (copilot-instructions.md) - Comprehensive documentation - README.md - CONTRIBUTING.md - al-development.md - LICENSE (MIT) - Reference documentation for AI Native-Instructions Architecture ### Framework Compliance - Implements AI Native-Instructions Architecture - 3-layer framework: Markdown Prompt Engineering, Agent Primitives, Context Engineering - Context optimization via `applyTo` patterns - AGENTS.md compilation ready --- ## Release Notes ### Version Numbering This project follows [Semantic Versioning](https://semver.org/): - **MAJOR** version for incompatible API changes or breaking changes - **MINOR** version for new features in a backward compatible manner - **PATCH** version for backward compatible bug fixes ### Types of Changes - **Added** for new features - **Changed** for changes in existing functionality - **Deprecated** for soon-to-be removed features - **Removed** for now removed features - **Fixed** for any bug fixes - **Security** for vulnerability fixes ### Links - [AI Native-Instructions Architecture](https://danielmeppiel.github.io/awesome-ai-native/) - [Repository](https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot) - [Issues](https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/issues) - [Discussions](https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/discussions) [Unreleased]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.10.0...HEAD [2.10.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.9.0...v2.10.0 [2.9.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.8.0...v2.9.0 [2.8.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.7.0...v2.8.0 [2.7.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.6.0...v2.7.0 [2.6.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.5.0...v2.6.0 [2.5.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.4.0...v2.5.0 [2.4.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.1.0...v2.4.0 [2.1.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v2.0.0...v2.1.0 [2.0.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/compare/v1.0.0...v2.0.0 [1.0.0]: https://github.com/javiarmesto/AL-Development-Collection-for-GitHub-Copilot/releases/tag/v1.0.0