🚀 webMethods.io Integration DevOps Framework — Extended

This document extends the original automation framework for webMethods.io Integration, highlighting new capabilities such as Integration API support, multi-asset promotion, integrated code review, and secret vault support. The framework is designed with GitHub repositories and Azure DevOps pipelines but can be adapted to other platforms.

📌 What's New

• ✅ API (Integration) Support
  Automate API (integrations) promotion, alongside workflows, flowservices.
• ✅ Multi-Asset Promotion Support
  Promote multiple assets (APIs, workflows, flowservices, reference data, projectParameters) together in a single release cycle. (Complete Project support has been there from beginning)
• ✅ Integrated Code Review Process
  Added "code review" as a quality gate using ISCCR (Licensed) for flow services. code review blog
• ✅ Account/Connection Promotion Support
  Added support for automating Account promotion with separating metadata and credentials (Vault) and also separate config per stage.
• ✅ Secret Vault Integration
  Sensitive credentials (tokens, client secrets, credentials) for account/connections can stored in Azure Key Vault or GitHub secrets and auto-injected during deployments.
• ✅ Simplified Configuration Management
  YAML-based project configurations track accounts, secrets, and environment-specific metadata.

📈 Framework Overview

1. Export & Version Control
   • Assets are exported from webMethods.io using APIs.
   • Secrets are extracted, masked, and stored separately.
   • Code and metadata are committed to GitHub.
2. Pull Request & Code Review
   • Developers raise pull requests for new or updated assets.
   • Code review workflows ensure peer validation before merge. This could also be triggered on PRs (say feature --> codeReview branch)
3. Promotion & Deployment
   • Azure DevOps triggers automate import and deployment.
   • Vault secrets are dynamically injected before deployment.
   • Supports batch promotion of multiple assets.
4. Automated Testing (Optional)
   • Postman/Newman test collections validate assets post-deployment.

🛠️ Components

This is a sample setup, but definitely not limited to the above components, framework could be used with other components like, bitbucket, bamboo, gitlab, jenkins etc.

🔐 Vault Integration

• Secrets stored securely in:
  • Azure Key Vault (recommended for Azure-hosted projects)
  • GitHub Encrypted Secrets (fallback)
• During import, masked fields are dynamically replaced with actual secrets from vault.

⚖️ Multi-Asset Promotion Workflow (Individual asset promotion)

• Supports selecting and promoting multiple assets together:
  • APIs
  • workflows
  • flowservices
  • Reference Data
  • Project parameters

📊 Code Review Enforcement

• Feature branch-based development.
• Pull Requests mandatory before merging to DEV/QA/PROD branches.
• Peer reviews using GitHub workflows.
• Secrets never committed in clear text.

📊 Example Pipelines

📘 Documentation & Resources

• Framework Repository
• IBM webMethods.io API Docs
• Official CLI (Being Migrated)
• Original Framework
• Code review blog

🤝 Contribution

• Fork → Enhance → Pull Request.
• Contributions welcome for:
  • New orchestration platform adapters.
  • Additional secret providers.
  • Pipeline optimization.

⚠️ Disclaimer
IBM Public Repository Disclosure

All content in these repositories including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security, and will not be maintaining this code going forward.

🚀 Next Steps

• Develop Anywhere Deploy Anywhere (DADA / IWHI) support.
• Individual asset support for Account/Connection.
• Unit Testing.
• All Account/Connection types support (Note: Currently Public APIs supports selected Account)