azdev 0.1.81

设置开发环境

1. 从 https://pythonlang.cn 安装 Python 3.6+。请注意，预安装在OSX上的Python版本是2.7。

2. 分支和克隆您希望为其开发的存储库或存储库。

   • 对于 Azure CLI： https://github.com/Azure/azure-cli

   • 对于 Azure CLI 扩展： https://github.com/Azure/azure-cli-extensions

   • 任何其他您可能可以访问的、包含 CLI 扩展的存储库。

3. 在您的克隆根目录中创建一个新的Python虚拟环境。您可以通过运行以下命令来实现：

   Python 3.6+（所有平台）

   python -m venv env

   或者

   python3 -m venv env

4. 通过运行以下命令激活env虚拟环境：

   Windows CMD.exe

   env\scripts\activate.bat

   Windows Powershell

   env\scripts\activate.ps1

   OSX/Linux (bash)

   source env/bin/activate

5. 通过运行以下命令安装azdev：

   pip install azdev

6. 通过运行以下命令完成设置：

   azdev setup

   这将启动交互式设置过程。要查看非交互式选项，请运行azdev setup -h。

问题报告和反馈

如果您在工具中发现任何错误，请在我们GitHub仓库的问题部分提交问题。

贡献代码

本项目已采用Microsoft 开源代码行为准则。

有关更多信息，请参阅行为准则常见问题解答或联系opencode@microsoft.com，提出任何额外的问题或意见。

如果您想成为本项目的积极贡献者，请按照Microsoft Azure 项目贡献指南中提供的说明进行操作。

许可证

Azure CLI Dev Tools (azdev)

Copyright (c) Microsoft Corporation
All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.::

0.1.81

• azdev scan/mask：添加–confidence-level以支持秘密模式级别

0.1.80

• azdev cmdcov：支持扩展短名和长名

• azdev cmdcov：修复排序问题

• azdev test：修复windows平台subprocess中的可执行文件不一致问题

0.1.79

• 修复配置文件选项

0.1.78

• 减轻用户输入导致的shell注入风险。

0.1.77

• azdev extension cal-next-version：修复使用major、minor、patch标记预览版本时的pre_num

0.1.76

• azdev extension cal-next-version：修复预览版到稳定版的情况

0.1.75

• azdev scan/mask：添加–include-pattern和–exclude-pattern以支持目录内文件过滤

0.1.74

• azdev scan/mask：添加扫描和屏蔽文件或字符串中秘密的新命令

0.1.73

• azdev command-change meta-export：添加has_completer以表示是否在参数中配置了补全器

• azdev command-change meta-export：提取加载的HelpFiles的参数帮助和示例

0.1.72

• 将升级到3

0.1.71

• azdev extension show：显示已安装在你的开发环境中的详细扩展信息。

• azdev extension cal-next-version：修复从index.json解析最后稳定版本的问题。

0.1.70

• 修复cmdcov问题(#455)：删除tested_command.txt引用。

0.1.69

• azdev command-change tree-export：添加命令帮助信息。

0.1.68

• azdev command-change tree-export：添加新命令以支持导出CLI模块的命令树。

0.1.67

• azdev extension cal-next-version：根据最后版本的标签和下一个版本的稳定/预览标签来合理化preview/exp标签操作。

0.1.66

• azdev style：当在azure cli/ext仓库中找不到.flake8和pylintrc时，使用azdev配置文件。

0.1.65

• azdev command-change meta-diff：为子组、cmd、参数和选项中的deprecate_info添加diff支持。

0.1.64

• azdev extension cal-next-version：修复从index查询扩展模块时的模块名。

0.1.63

• azdev：更新对azure-cli-diff-tool的所需版本。

0.1.62

• azdev extension cal-next-version：添加新命令以计算下一个扩展模块发布的有效版本。

0.1.61

• azdev test：添加一些示例。

• azdev style：修改_update_table函数的执行顺序。

• azdev linter：修复_detected_tested_command的bug，严格限制以test开头并以.py或.yaml结尾

0.1.60

• azdev statistics list-command-table：处理无法检索源代码时的异常

0.1.59

• azdev command-change meta-export：标准化基本cmd类型：str、bool、int、float

0.1.58

• 修复cmdcov问题(#417)：任何参数名称已被测试，则应将该参数视为通过参数测试覆盖率。

0.1.57

• azdev 命令更改 meta-diff：删除重复的 meta-diff 代码，使用 azure-cli-diff-tool

0.1.56

• 修复 cmdcov 问题(#410)：在 get_cli_repo_path 失败时从 github 获取配置

0.1.55

• azdev 命令更改 meta-diff：修复 data/meta_change_whitelist.txt 包构建问题

0.1.54

• azdev 命令更改 meta-export/meta-diff：添加 type 提取命令，修复 cmdPropUpdate 中的误报并添加某些 meta 变化的白名单 (#401)

0.1.53

• azdev 命令更改 meta-export：添加规则链接 (#402)

0.1.52

• 修复 cmdcov 问题(#396)：修复获取命令组时使用的正则表达式

0.1.51

• 修复 cmdcov 问题(#391)：向 cmdcov 检查规则添加违规信息并修复相关问题

0.1.50

• 修复 cmdcov 问题(#385)：将 cmdcov 添加到包数据中

0.1.49

• 为 CLI 模块添加命令覆盖率报告 (#323)

• 添加 Linter 规则 missing_command_coverage 和 missing_parameter_coverage (#323)

• 为 CLI 扩展添加命令覆盖率报告 (#383)

0.1.48

• azdev 命令更改 meta-export：添加选项弃用信息和忽略 cmd 参数 (#381)

0.1.47

• azdev 命令更改 meta-export：从模块加载器加载参数 (#378)

0.1.46

• azdev 命令更改 meta-diff：添加子组变更检测 (#374)

0.1.45

• azdev 命令更改 meta-diff：细化无 meta 差异输出 (#372)

0.1.44

• azdev 命令更改 meta-export：修复对象转储失败 (#370)

0.1.43

• azdev 统计 list-command-table：修复意外的缩进 (#368)

0.1.42

• azdev 命令更改 meta-export/meta-diff：生成 CLI 命令元数据和两个元数据之间的差异 (#362)

0.1.41

• azdev 统计 list-command-table：支持嵌套函数的统计 (#363)

0.1.40

• 修复 pytest 问题 (#347)

0.1.39

• 修复包问题 (#345)

0.1.38

• azdev 统计 list-command-table：列出 CLI 模块的命令表 (#342)

• azdev 统计 diff-command-tables：比较命令表变化 (#343)

0.1.37

• azdev 验证许可证：支持 CodeGen V2 许可证 (#334)

• azdev 测试：撤销 integrate pytest-cov (#327)

0.1.36

• 移除 colorama 引用 (#321)

0.1.35

• 支持 Python 3.10 (#319)

• 将 master 分支替换为 main 分支 (#315)

• 弃用 mock 库 (#313)

• 添加扩展仓库缺失错误 (#309)

0.1.34

• azdev 检查器：支持检测命令组表（command_group_table）中缺失的命令组 (#308)

0.1.33

• 将 pylint 升级到 2.8.2 并将 –ignore 移至 pylintrc 文件 (#301)

0.1.32

• 将 pylint 升级到 2.8.0 (#295)

0.1.31

• azdev 样式：通过锁定 astroid 到 2.4.2 修复 pylint

• 修复 _copy_vendored_sdk 以支持 Track 2 SDK (#293)

0.1.30

• 更改 azure-storage-blob 依赖 (#290)

0.1.29

• azdev 检查器：在选项长度计算中移除前缀破折号 (#284)

• azdev 设置：如果 pip 命令失败则显示错误 (#281)

• 支持 Python 3.9 (#280)

0.1.28

• [检查器] 修复 azdev 检查器 中的轻微显示问题。

0.1.27

• [检查器] “显示”命令应使用 show_command 或 custom_show_command。

0.1.26

• 支持 PEP420 包

0.1.25

• azdev 测试：添加新参数 –mark

• 更新调用 pytest 的方式

• azdev 性能基准：细化输出

• 支持 PEP420 包

0.1.24

• [检查器] 参数必须有一个长度小于 22 的选项。

• [检查器] 参数不能包含 “_”。

0.1.23

• [检查器] 只有违反高严重性规则才会以 1 退出。

• 最小 pytest 版本要求至少为 5.0.0。

0.1.22

• 尊重 Azure/azure-cli 和 Azure/azure-cli-extensions 中的 pylint 和 flake8 配置。

• 重命名测试文件夹以腾出空间供其他命令的单元测试。

• 启用测试结果覆盖率。

0.1.21

• 将 isort 包版本修复为 4.3.21。

• azdev 性能基准：支持新的命令来计算每个命令的执行时间。

0.1.20

• azdev 设置：修复 azure-cli-testsdk 的缺失依赖项 (#370)

0.1.19

• 将 parameter_should_not_end_in_resource_group 的严重性降低到中等。

• 修复 azdev test 在具有中文系统语言的 Windows 上无法工作的问题。

0.1.18

• 代码检查规则严重性：规则现在具有关联的严重性级别。只有高严重性规则应在CI中运行。所有之前的规则都被标记为高严重性。

  • 注意：高严重性规则是严重的，通常应该修复而不是排除。低严重性规则通常是信息性的，可能会产生误报。通过CLI中的linter_exclusions.yml排除它们。

• azdev linter：公开–min-severity以支持规则严重性的概念。还添加了新的高、中、低严重性规则。

0.1.17

• azdev setup：添加了选项–deps-from以允许从requirements.txt或setup.py解析依赖项。默认值更改为requirements.txt。

0.1.16

• azdev test：添加选项–no-exit-first以禁用检测到失败后pytest退出。

0.1.15

• 当不需要运行测试时使用sys.exit(0)而不是引发CLIError。

0.1.14

• 使用ProfileContext细化针对不同配置文件的测试逻辑。

• pytest版本限制更改为pytest>=4.4.0。

• 使用AzureDevOpsContext应用增量测试策略。

• 细化azdev test的主流程，使其更加紧凑和整洁。

0.1.13

• azdev verify license：修复在检查扩展时跳过文件的问题。

0.1.12

• azdev extension publish：修复未提供–yes时的问题。

• azdev verify license：支持CodeGen生成的许可证。

• 停止支持Python 2和Python 3.5。

0.1.11

• azdev extension build：移除–universal以尊重setup.cfg。

0.1.10

• 放宽microsoft/Knack的版本限制。

0.1.9

• azdev extension publish：添加–storage-account-key并移除–storage-subscription。

• azdev extension update-index：移除将使此命令失败的不必要警告。

• CI：在ADO中使用pip install -e代替，以修复导入错误。

0.1.8

• 修复：azdev test不能在python 3.8.1或更高版本中使用。

0.1.7

• 修复：azdev test找不到核心测试。

0.1.6

• 修复错误：azdev==0.1.5帮助命令的错误。

0.1.5

• azdev extension add/remove

  • 添加能力，通过提供通配符(*)安装所有可用的开发扩展。

  • 添加能力，删除所有已安装的开发扩展。

• azdev setup

  • 添加能力，使用–ext/-e *安装所有扩展。

  • 添加能力，使用–cli/-c EDGE安装CLI边缘构建版本。

• azdev style/test/linter

  • 添加特殊名称CLI和EXT，允许仅运行CLI模块或仅运行扩展。扩展基于git diff进行了更改。

• azdev linter

  • 添加了–include-whl-extensions标志，允许在通过az extension add命令安装的扩展上运行linter。

• azdev verify license

  • 命令将不会检查任何开发安装的CLI和扩展存储库。以前，它只检查CLI存储库。

• 新命令

  • azdev cli/extension generate-docs用于生成sphinx文档。

0.1.4

• azdev linter：修复帮助示例规则的问题。

• azdev style：从核心模块中省略命名空间包。

• azdev verify document-map：更新以正确地在Linux上工作。

0.1.3

• azdev linter：修复在某些安装中由于找不到ci_exclusions.yml而失败的问题。

0.1.2

• azdev setup：修复了安装后无法运行azure.cli的回归问题。

0.1.1

• azdev cli/extension create：修复支持文件未包含的问题。调整生成逻辑。

0.1.0

• 更新以兼容azure-cli 2.0.68的新包结构。

• 重大更改：已删除azdev cli update-setup。将包更改到azure-cli不再需要此操作。

• 重大更改：azdev verify history和azdev cli check-versions不再接受任何参数。由于现在模块很少，这些被认为是不必要的。

0.0.6

• 添加了新的命令azdev cli create和azdev extension create来构建新的模块/扩展。

• azdev setup：改进交互式体验。

• azdev test：修复使用–profile时未使用正确索引的问题。

  更改行为，在测试完成后切换回原始配置文件。

0.0.5

• 修复了当使用短名称形式时，azdev cli check-versions不接受模块名称的问题。

• 更新了azdev cli check-versions，允许将模块作为位置参数，与其他azdev命令保持一致。

• 修复了当扩展库中存在虚拟环境时，azdev test –discover可能导致堆栈跟踪的问题。

0.0.4

• 修复了azdev setup中的关键错误。

0.0.3

• 添加了新的命令azdev extension build和azdev extension publish，以简化扩展的发布。

• 更新了在扩展上使用时的默认排除规则azdev linter。

• 为azdev linter添加了–ci-exclusions标志，以在本地运行时模拟CI模式。

• 修复了当克隆库中存在虚拟环境时，azdev test –discover可能导致堆栈跟踪的问题。

• 调整了azdev per load-times的阈值。

0.0.2

• 更改了azdev test的行为，默认情况下运行所有测试，以与azdev style和azdev linter等命令保持一致。

• 删除了azdev verify version，并将其拆分为两个命令：azdev cli check-versions和azdev cli update-setup。

• 对代码进行各种修改，以更好地与azure-cli的CI构建系统兼容。

• 重写了azdev perf load-times，以减少虚假失败。

0.0.1

• 首次发布