# cumulusci-azure-devops
A plugin for [CumulusCI](https://github.com/SFDO-Tooling/CumulusCI) supporting Azure DevOps integration.
## Features
- Integrates Azure DevOps pipelines with CumulusCI
- Provides tasks and utilities for Azure DevOps automation
## Installation
### Recommended Installation (with conflict checking)
For the best experience, use our custom installation script that checks for conflicts:
```bash
# Download and run the installation script
curl -O https://raw.githubusercontent.com/jorgesolebur/CumulusCI_AzureDevOps/main/install.py
python install.py
```
### Manual Installation via pipx (recommended)
**Option 1: Install main app, then inject plugin (recommended)**
```bash
# Install cumulusci-plus first to get cci and snowfakery commands
pipx install cumulusci-plus
# Inject the plugin into the same environment for proper plugin discovery
pipx inject cumulusci-plus cumulusci-plus-azure-devops --include-apps
```
**Option 2: Single installation with dependency scripts**
```bash
# Install with --include-deps to expose dependency console scripts
pipx install cumulusci-plus-azure-devops --include-deps
```
**Option 3: Basic installation (Azure DevOps plugin only)**
```bash
pipx install cumulusci-plus-azure-devops
```
> **Why Option 1 is recommended**: CumulusCI plugins need to be in the same environment as the main application for proper plugin discovery. Using `pipx inject` ensures the plugin is installed in the same virtual environment as `cumulusci-plus`.
### Manual Installation via pip
```bash
pip install cumulusci-plus-azure-devops
```
## Upgrading
### Recommended Upgrade Method
Use our custom upgrade script for the best experience:
```bash
# Download and run the upgrade script
curl -O https://raw.githubusercontent.com/jorgesolebur/CumulusCI_AzureDevOps/main/upgrade.py
python upgrade.py
```
### Manual Upgrade via pipx
**For injected installations (recommended method):**
```bash
# Upgrade main package and update plugin
pipx upgrade cumulusci-plus
pipx inject cumulusci-plus cumulusci-plus-azure-devops --include-apps --force
# Or force reinstall everything
pipx uninstall cumulusci-plus
pipx install cumulusci-plus
pipx inject cumulusci-plus cumulusci-plus-azure-devops --include-apps
```
**For --include-deps installations:**
```bash
# Standard upgrade
pipx upgrade cumulusci-plus-azure-devops
# Or force reinstall
pipx uninstall cumulusci-plus-azure-devops
pipx install cumulusci-plus-azure-devops --include-deps
```
### Why Use the Upgrade Script?
The upgrade process varies depending on how you installed the package. Our upgrade script:
- ✅ **Detects installation method** (injected vs main package vs unknown)
- ✅ **Applies correct upgrade process** for each method
- ✅ **Handles plugin discovery** properly for injected installations
- ✅ **Checks current dependency versions** before and after upgrade
- ✅ **Provides installation-specific guidance** and next steps
- ✅ **Ensures dependencies are updated** to latest versions
**Installation Method Detection:**
- **Injected**: Plugin installed via `pipx inject` (recommended) ✅
- **Main Package**: Plugin installed via `--include-deps` ✅
- **Unknown**: Fallback for edge cases ⚠️
### Important Notes
- **Plugin Discovery**: For CumulusCI to discover and use this plugin, it must be installed in the same environment as `cumulusci-plus`. This is why Option 1 (using `pipx inject`) is recommended.
- **Conflict Warning**: This package is designed to work with `cumulusci-plus` (version 5.0.0+), not the original `cumulusci` package. Having both installed may cause conflicts.
- **pipx vs pip**: We recommend using `pipx` for CLI tools as it provides better isolation and prevents dependency conflicts.
- **Dependencies**: All required dependencies (including `cumulusci-plus`, `azure-devops`, etc.) are automatically installed.
- **Console Scripts**: After installation, you'll have access to these commands:
- `cci` and `snowfakery` (from cumulusci-plus)
- `cumulusci-ado` and `cci-ado` (from this plugin)
### Available Console Scripts
**From cumulusci-plus:**
- `cci` - Main CumulusCI command
- `snowfakery` - Data generation tool
**From this plugin:**
- `cumulusci-ado` - Azure DevOps plugin CLI
- `cci-ado` - Short alias for plugin CLI
### Plugin Discovery
**✅ Plugin is discoverable when:**
- Installed via `pipx inject` (Option 1)
- Installed via `--include-deps` (Option 2)
**❌ Plugin is NOT discoverable when:**
- Installed as separate pipx packages
- Main app and plugin are in different environments
When the plugin is properly discoverable, you can use it in your `cumulusci.yml` configuration and CumulusCI will automatically find and load it.
## Usage
### Plugin Management Commands
After installation, you can use these commands to manage the plugin:
```bash
# Check plugin installation status
cumulusci-ado status
# Show version information
cumulusci-ado version
# Get help
cumulusci-ado help
# Short alias versions
cci-ado status
cci-ado version
cci-ado help
```
### CumulusCI Integration
Add the plugin to your `cumulusci.yml`:
```yaml
plugins:
azure_devops:
path: cumulusci_ado
```
Or use via the CumulusCI CLI if installed as a package. The plugin will automatically integrate with CumulusCI when installed.
## Development
- Requires Python 3.11+
- See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines (if available)
## License
GNU General Public License v3.0
## Links
- [CumulusCI](https://github.com/SFDO-Tooling/CumulusCI)
- [Azure DevOps Python API](https://github.com/microsoft/azure-devops-python-api)
Raw data
{
"_id": null,
"home_page": null,
"name": "cumulusci-plus-azure-devops",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "azure devops, cumulusci, salesforce",
"author": "Rupesh J",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f3/56/de032b64c55b39c434ccd9f093daf5b06e0437f5cafe9aff6fa599d8661d/cumulusci_plus_azure_devops-0.0.6.tar.gz",
"platform": null,
"description": "# cumulusci-azure-devops\n\nA plugin for [CumulusCI](https://github.com/SFDO-Tooling/CumulusCI) supporting Azure DevOps integration.\n\n## Features\n\n- Integrates Azure DevOps pipelines with CumulusCI\n- Provides tasks and utilities for Azure DevOps automation\n\n## Installation\n\n### Recommended Installation (with conflict checking)\n\nFor the best experience, use our custom installation script that checks for conflicts:\n\n```bash\n# Download and run the installation script\ncurl -O https://raw.githubusercontent.com/jorgesolebur/CumulusCI_AzureDevOps/main/install.py\npython install.py\n```\n\n### Manual Installation via pipx (recommended)\n\n**Option 1: Install main app, then inject plugin (recommended)**\n\n```bash\n# Install cumulusci-plus first to get cci and snowfakery commands\npipx install cumulusci-plus\n\n# Inject the plugin into the same environment for proper plugin discovery\npipx inject cumulusci-plus cumulusci-plus-azure-devops --include-apps\n```\n\n**Option 2: Single installation with dependency scripts**\n\n```bash\n# Install with --include-deps to expose dependency console scripts\npipx install cumulusci-plus-azure-devops --include-deps\n```\n\n**Option 3: Basic installation (Azure DevOps plugin only)**\n\n```bash\npipx install cumulusci-plus-azure-devops\n```\n\n> **Why Option 1 is recommended**: CumulusCI plugins need to be in the same environment as the main application for proper plugin discovery. Using `pipx inject` ensures the plugin is installed in the same virtual environment as `cumulusci-plus`.\n\n### Manual Installation via pip\n\n```bash\npip install cumulusci-plus-azure-devops\n```\n\n## Upgrading\n\n### Recommended Upgrade Method\n\nUse our custom upgrade script for the best experience:\n\n```bash\n# Download and run the upgrade script\ncurl -O https://raw.githubusercontent.com/jorgesolebur/CumulusCI_AzureDevOps/main/upgrade.py\npython upgrade.py\n```\n\n### Manual Upgrade via pipx\n\n**For injected installations (recommended method):**\n\n```bash\n# Upgrade main package and update plugin\npipx upgrade cumulusci-plus\npipx inject cumulusci-plus cumulusci-plus-azure-devops --include-apps --force\n\n# Or force reinstall everything\npipx uninstall cumulusci-plus\npipx install cumulusci-plus\npipx inject cumulusci-plus cumulusci-plus-azure-devops --include-apps\n```\n\n**For --include-deps installations:**\n\n```bash\n# Standard upgrade\npipx upgrade cumulusci-plus-azure-devops\n\n# Or force reinstall\npipx uninstall cumulusci-plus-azure-devops\npipx install cumulusci-plus-azure-devops --include-deps\n```\n\n### Why Use the Upgrade Script?\n\nThe upgrade process varies depending on how you installed the package. Our upgrade script:\n\n- \u2705 **Detects installation method** (injected vs main package vs unknown)\n- \u2705 **Applies correct upgrade process** for each method\n- \u2705 **Handles plugin discovery** properly for injected installations\n- \u2705 **Checks current dependency versions** before and after upgrade\n- \u2705 **Provides installation-specific guidance** and next steps\n- \u2705 **Ensures dependencies are updated** to latest versions\n\n**Installation Method Detection:**\n\n- **Injected**: Plugin installed via `pipx inject` (recommended) \u2705\n- **Main Package**: Plugin installed via `--include-deps` \u2705\n- **Unknown**: Fallback for edge cases \u26a0\ufe0f\n\n### Important Notes\n\n- **Plugin Discovery**: For CumulusCI to discover and use this plugin, it must be installed in the same environment as `cumulusci-plus`. This is why Option 1 (using `pipx inject`) is recommended.\n- **Conflict Warning**: This package is designed to work with `cumulusci-plus` (version 5.0.0+), not the original `cumulusci` package. Having both installed may cause conflicts.\n- **pipx vs pip**: We recommend using `pipx` for CLI tools as it provides better isolation and prevents dependency conflicts.\n- **Dependencies**: All required dependencies (including `cumulusci-plus`, `azure-devops`, etc.) are automatically installed.\n- **Console Scripts**: After installation, you'll have access to these commands:\n - `cci` and `snowfakery` (from cumulusci-plus)\n - `cumulusci-ado` and `cci-ado` (from this plugin)\n\n### Available Console Scripts\n\n**From cumulusci-plus:**\n\n- `cci` - Main CumulusCI command\n- `snowfakery` - Data generation tool\n\n**From this plugin:**\n\n- `cumulusci-ado` - Azure DevOps plugin CLI\n- `cci-ado` - Short alias for plugin CLI\n\n### Plugin Discovery\n\n**\u2705 Plugin is discoverable when:**\n\n- Installed via `pipx inject` (Option 1)\n- Installed via `--include-deps` (Option 2)\n\n**\u274c Plugin is NOT discoverable when:**\n\n- Installed as separate pipx packages\n- Main app and plugin are in different environments\n\nWhen the plugin is properly discoverable, you can use it in your `cumulusci.yml` configuration and CumulusCI will automatically find and load it.\n\n## Usage\n\n### Plugin Management Commands\n\nAfter installation, you can use these commands to manage the plugin:\n\n```bash\n# Check plugin installation status\ncumulusci-ado status\n\n# Show version information\ncumulusci-ado version\n\n# Get help\ncumulusci-ado help\n\n# Short alias versions\ncci-ado status\ncci-ado version\ncci-ado help\n```\n\n### CumulusCI Integration\n\nAdd the plugin to your `cumulusci.yml`:\n\n```yaml\nplugins:\n azure_devops:\n path: cumulusci_ado\n```\n\nOr use via the CumulusCI CLI if installed as a package. The plugin will automatically integrate with CumulusCI when installed.\n\n## Development\n\n- Requires Python 3.11+\n- See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines (if available)\n\n## License\n\nGNU General Public License v3.0\n\n## Links\n\n- [CumulusCI](https://github.com/SFDO-Tooling/CumulusCI)\n- [Azure DevOps Python API](https://github.com/microsoft/azure-devops-python-api)\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "A plugin for cumulusci plus supporting Azure DevOps",
"version": "0.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/jorgesolebur/CumulusCI_AzureDevOps/issues",
"Homepage": "https://github.com/jorgesolebur/CumulusCI_AzureDevOps"
},
"split_keywords": [
"azure devops",
" cumulusci",
" salesforce"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "168679641ecb2a757d035bba1d12e174d04a8c1d1a8ca54d41d0b4c2c271e2d3",
"md5": "e682f56bd01d3932522667e3d4820fb0",
"sha256": "0c35668741215ae0d5ab289122b3e92595a2170dbcb520ed98561b3aff852da8"
},
"downloads": -1,
"filename": "cumulusci_plus_azure_devops-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e682f56bd01d3932522667e3d4820fb0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 61738,
"upload_time": "2025-07-11T05:23:01",
"upload_time_iso_8601": "2025-07-11T05:23:01.411491Z",
"url": "https://files.pythonhosted.org/packages/16/86/79641ecb2a757d035bba1d12e174d04a8c1d1a8ca54d41d0b4c2c271e2d3/cumulusci_plus_azure_devops-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f356de032b64c55b39c434ccd9f093daf5b06e0437f5cafe9aff6fa599d8661d",
"md5": "fcf1fc390c7192059f7d860acb68290a",
"sha256": "5906cd54f226885a06c05595deb4bab61fff660e02bbe04a3f8d5cdea4ad1a01"
},
"downloads": -1,
"filename": "cumulusci_plus_azure_devops-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "fcf1fc390c7192059f7d860acb68290a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 53546,
"upload_time": "2025-07-11T05:23:00",
"upload_time_iso_8601": "2025-07-11T05:23:00.397741Z",
"url": "https://files.pythonhosted.org/packages/f3/56/de032b64c55b39c434ccd9f093daf5b06e0437f5cafe9aff6fa599d8661d/cumulusci_plus_azure_devops-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 05:23:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jorgesolebur",
"github_project": "CumulusCI_AzureDevOps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cumulusci-plus-azure-devops"
}
JSON
