1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
# Development setup
## Install pre-reqs
1. Install Python 3.5 or later from python.org, apt-get, or some other installer.
1. Install Virtual Python Environment (virtualenv):
```bash
pip install virtualenv
```
## Get the source
1. Clone the Azure Devops CLI extension repository.
```bash
git clone https://github.com/Microsoft/azure-devops-cli-extension
```
1. Checkout `master` branch.
```bash
git checkout master
```
## Create a virtual environment
1. From the `azure-devops-cli-extension` directory, create a new virtual environment:
```bash
virtualenv env
```
1. Activate the new virtual environment:
On Linux:
```bash
source env/bin/activate
```
On Windows:
```bash
env\Scripts\activate.bat
```
1. Run the `dev_setup.py` script to install the Azure Devops CLI packages and other dependencies into your virtual environment:
```bash
python scripts/dev_setup.py
```
## Developing
Run `az extension list` and `az devops -h` to verify your environment is setup properly.
1. Follow instructions to install powershell from [here](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-6)
1. `dev_setup.py` script has already set your `AZURE_EXTENSION_DIR` environment variable to `.azure\devcliextensions` directory that will hold the extensions being developed
On Windows
Run below command any time you make changes to your extension and want to see them reflected in the CLI.
```bash
pip install --upgrade --target %AZURE_EXTENSION_DIR%\azure-devops Dev\azure-devops-cli-extension\azure-devops
```
* `%AZURE_EXTENSION_DIR%\azure-devops` is the directory `pip` will install the extension to.
* `Dev\azure-devops-cli-extension\azure-devops` is the directory with the source code of your extension.
On Linux
```bash
pip install --upgrade --target $AZURE_EXTENSION_DIR/azure-devops Dev\azure-devops-cli-extension\azure-devops/
```
1. Run `az devops -h` again to verify if extension is installed properly.
|
