CommandBox & ForgeBox Package Management
0 likes1,178 views
Luis Majano, CEO of Ortus Solutions, discusses the challenges and future of ColdFusion Markup Language (CFML) development, emphasizing the need for better tooling, package management, and modern practices. He introduces CommandBox, a CLI package manager that enhances CFML applications through features like scaffolding, task runners, and cloud package management with ForgeBox. The presentation highlights the importance of collaboration in the CFML community to overcome legacy issues and innovate with new applications and libraries.
CommandBox & ForgeBox Package Management
- 2. WHO AM I? âą Luis Majano âą Computer Engineer âą Imported from El Salvador âą CEO of Ortus Solutions âą Adobe Community Professional âą Sandals & Beaches -> ESRI -> Ortus
- 3. Legacy CFML Modern CFML CommandBox Packages ForgeBox Collaboration Making CFML Huuugeee Again!
- 4. HOW DO WE WORK IN CF? Code% App% Code Code Code Code Code Code Code
- 6. CFML SHAMING âą Lack of tooling âą Package Management âą CLI âą OS Integrations âą Applications âą Legacy Hell âą Way behind the cool kids
- 7. How we should work! App#Package# Manager# CLI# REPL# Automa6on# OS#
- 8. Take CFML Back to The Future
- 10. Package Manager, REPL, CLI + More 3Years Now!
- 11. What is CommandBox? CLI Packageâš Manager REPL Read-Evalâš Print-Loop Integratedâš Server ScaffoldingForgeBox CFML ColdFusion Automation Task Runners
- 14. CLI Packageâš Manager REPL Read-Evalâš Print-Loop Integratedâš Server ScaffoldingForgeBox CFML ColdFusion Automation Task Runners What is CommandBox?
- 15. Donât touch that Node! Brad Woodâš Salsa King http://bit.ly/dont-touch-node-use-commandbox We have everything we need in CFML We just need you to write packages
- 16. Usage - CLI vs Shell box myapp.cfm Shell
- 17. Commands âą How you get things done! âą Built-in Help âą command help âą Command Namespaces âą Commands âą Aliases âą Parameters/Arguments âą Tab-Completion âą Commands, Parameters, Paths, ForgeBox, Custom
- 18. Whatâs a package? âą A folder or zip/tar ïŹle that must contain: âą box.json âą It must be in the root! init name="My Package" version="1.0.0"
- 19. Where can it be used? CFML âš App $ CLI
- 20. box.json âą Package Descriptor âą Declares package metadata âą Name âą Slug âą Version âą Author âą Dependencies âą DevDependencies âą Installation Details âą Custom Metadata âą Package Scripts âą Listen to CLI/Server/OS Events
- 22. Working With Packages $ package help
- 23. Where do they come from? âą ForgeBox âą File zip/tar âą Directory âą Git âą SVN âą Github âą Bitbucket âą HTTP/S âą JAR Code Endpoints install coldbox@4.3.0 install coldbox@be install http://www.site.com/myPackage.zip install https://maven/myjar.jar install /var/libs/myPackage.zip install /var/libs/myPackage/ install username/repoName.git#v1.5.6
- 24. Packaging Features âą Can distribute without dependencies âą Can have development dependencies âą Dependencies Inception âą âinstallâ to initialize a project âą âupdateâ to update dependencies âą âoutdatedâ to check for versions âą âlistâ to visualize dependencies âą âuninstallâ to uninstall dependencies
- 25. Multi-Version Support âą ForgeBox Endpoint Only âą Public/Private Packages âą Based on SemanticVersioning: https://semver.org âą <major>.<minor>.<patch> âą Used for versioning your packages âą Used for installing/updating packages
- 26. # Latest stable version CommandBox> install foo # Same as above CommandBox> install foo@stable # latest version, even if pre release (bleeding edge) CommandBox> install foo@be # A specific version CommandBox> install foo@1.2.3 # Any version with a major number of 4 (4.1, 4.2, 4.9, etc) CommandBox> install foo@4.x # Any version greater than 1.5.0 CommandBox> install foo@>1.5.0 # Any version greater than 5.2 but less than or equal to 6.3.4 CommandBox> install "foo@>5.2 <=6.3.4" # Any version greater than or equal to 1.2 but less than or equal to 3.2 CommandBox> install "foo@1.2 - 3.2" # Allows patch-level changes if a minor version exists. Allows minor-level changes if not. âš (2.1.2, 2.1.3, 2.1.4, etc) CommandBox> install foo@~2.1 # Any greater version that does not modify the left-most non-zero digit. 4.2, 4.3, 4.9, etc CommandBox> install foo@^4.1.4
- 27. Package Scripts âą Interceptor-based CLI Scripts âą Listen to CommandBox Events âą Supports Expansions, CFML functions, piping, environment variables, etc. "scripts" : { "postVersion" : "package set location='gitUser/gitRepo#v`package version`'", "postPublish" : "!git push --follow-tags" } âą Ad-hoc Scripts as well "scripts" : { "build" : "!grunt build && testsbox run && run-script generateAPIDocs && bump --patch && publish", "generateAPIDocs" : "docbox generate" }
- 28. Artifacts âą CommandBox caches downloaded artifcacts: ~/.Commandbox/artifacts âą artifacts help âą Snapshots are always downloaded âą Packages are organized by slug and versions âą Used for disconnected installs and accelerated build processes
- 30. What is ForgeBox âą https://forgebox.io âą ColdFusion (CFML) Code Directory âą Foster Community âą Works in Unison with CommandBox âą Cloud Package Management
- 31. ForgeBox Registration âą CLI or UI âą Ask you a few questions âą Ready to start publishing âą Registers an API Key for you forgebox register https://forgebox.io/security/registration
- 32. ForgeBox Commands $ forgebox help
- 33. ForgeBox Identities âą Login from CLI âą forgebox login âą Stores your API Key âą ~user./CommandBox âą Supports multiple logins âą forgebox use username âą Supports Who you are âą forgebox whoami
- 34. ForgeBox Publish âą Publishes your public/private packages âą Reads your box.json âą Can push your readme ïŹles, changelogs, instructions âą Make sure location key is set forgebox publish
- 35. Package Location âą ForgeBox needs to know where your package is âą ForgeBox Private will give you storage access (Soon) âą Can be any code endpoint âą HTTP/S âą Git âą Another ForgeBox slug "location" : âhttp://downloads.ortussolutions.com/cbantisamy/1.0.0/cbantisamy-1.0.0.zipâ âlocationâ : âcbfreshbooks@latestâ âlocationâ : âcoldbox-modules/testing#v1.2.3â
- 36. Dynamic Location âą CommandBox Interceptors - Lifecycle events âą Execute on pre+post publishing/versions/etc âą `` Denotes a dynamic evaluation âą Use Package Commands, etc { "scripts" : { "postVersion" : "package set location='gitUser/gitRepo#`package version`'" "postPublish" : "!git push", "onServerStart" : "echo 'Hi, thanks for starting `server show name` on port `server show web.http.port` in directory `pwd`'" } }
- 37. ForgeBox Un-publish âą Un-publish your version in the box.json âą Un-publish other versions, then go to UI forgebox unpublish
- 38. Bump Command âą Bump major, minor or patch placeholder âą If using a git repo, it will tag and commit for you bump --patch message="Finalized awesome features."
- 39. cb-module-template âą By Eric Peterson @elpete âą box.json and ModuleConïŹg.cfc values set âą UnitTesting âą IntegrationTesting with a built-in ColdBox app âą Publishing to ForgeBox with one command! (bump --major) âą AutomaticTravis-CI integration to run your tests on 5 different CF engine/versions with pass/fail badge on your readme. box module scaffold myCoolModule "Short Module Description"
- 40. PRO ACCOUNTS âą Monthly Subscription Service âą Private Packages âą Optional S3 Storage âą Unique Installation Strings âą FREE for limited time install @ortus/rafflebox
- 41. âą ForgeBox for Enterprise + Government âą Docker Image âą Encapsulated Dependencies âą Unique URI entrypoint âą Unique CommandBox Registrations forgebox register ortus http://fb.ortus.com install ortus:cfbox install ortus:@lmajano/cfbox ENTERPRISE IMAGE
- 42. âą Monthly Subscription Service âą Managed Containers @ Ortus Cloud âą Unique URI entrypoint âą Unique CommandBox Registrations ENTERPRISE MANAGED
- 43. WE NEEDYOU âą Get out of legacy hell, modernize âą Build cool apps,APIs, libraries âą Collaborate with open source âą Share in forgebox.io âą Blog, present, share your knowledge âą Proud of your CFML apps again!
- 44. Gracias! Q & A