Skip to content

Commit a8c3a5f

Browse files
Zim Kalinowskiroot
Zim Kalinowski
authored and
root
committed
updated cheatsheet (#10273)
* updated cheatsheet * better changelog * one more update
1 parent 51e854d commit a8c3a5f

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

doc/dev/mgmt/cheatsheet.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,21 @@ For all packages:<br/>
2020
`python ./scripts/dev_setup.py`
2121

2222
For a specific package:<br/>
23-
`python ./scripts/dev_setup.py -p azure-mgmt-servicename`
23+
24+
```shell
25+
export PACKAGE=azure-mgmt-servicename
26+
python ./scripts/dev_setup.py -p $PACKAGE
27+
```
2428

2529
## Generate tags for multi-api Swagger Readme
2630

2731
`python ./scripts/multi_api_readme_help.py /azure-rest-api-specs/specification/service/resource-manager/`
2832

2933
## Generate a package
3034

31-
`python -m packaging_tools.generate_sdk -v -m restapi_path/readme.md`
35+
```shell
36+
python -m packaging_tools.generate_sdk -v -m restapi_path/readme.md
37+
```
3238

3339
Regenerate multi-api client:<br/>
3440
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice`
@@ -60,11 +66,16 @@ Available options:
6066

6167
## ChangeLog
6268

63-
Generate code report for last version on PyPI:<br/>`python -m packaging_tools.code_report --last-pypi azure-mgmt-myservice`
64-
65-
Generate code report for version installed in current venv:<br/>`python -m packaging_tools.code_report azure-mgmt-myservice`
69+
Changelog is generated by performing following steps:
70+
- generate code report for last version on PyPI:
71+
- generate code report for version installed in current venv
72+
- generate a markdown changelog
6673

67-
Generate a markdown changelog:<br/>`python -m packaging_tools.change_log ./old_version_report.json ./new_version_report.json`
74+
```shell
75+
python -m packaging_tools.code_report --last-pypi $PACKAGE --output=$HOME/old.json
76+
python -m packaging_tools.code_report $PACKAGE --output=$HOME/new.json
77+
python -m packaging_tools.change_log $HOME/old.json $HOME/new.json
78+
```
6879

6980
## Tests
7081

0 commit comments

Comments
 (0)