简化发布创建的工具
rellu的Python项目详细描述
此项目包含工具和模板,以便于创建版本 在GitHub上发布,并在PyPI上发布。设计用于 Robot Framework及其生态系统中的工具和库,但可以 当然也可以被其他项目使用。
为了能够使用这个项目,你至少应该知道 Python packaging基础知识。
主要功能
- 可由自定义Invoke任务使用的实用程序。这些公用事业
可直接从rellu module:
- 导入
- 设置项目版本,包括自动将其设置为 下一个合适的开发版本。
- 在问题跟踪程序中设置公用标签。
- 根据跟踪程序中的问题生成发行说明。要求 使用预定义标签的项目
- rellu.tasks module:
- 中的一般任务Invoke
- 正在清理临时文件和目录。
- tasks.py使用上述方法实现Invoke任务的文件 公用事业。其他项目可以将其用作示例或模板。
- 在BUILD.rst文件中创建版本的分步说明 使用tasks.py文件、git和其他工具中定义的Invoke任务。 也可以将此文件用作模板。
- setup.py使用一般的良好实践,也可以用作 一个模板。也有超级简单的MANIFEST.in,但是这个项目 不需要setup.cfg。
依赖关系
rellu被设计成与Invoke一起使用,后者也被使用 在内部。所有项目依赖项都列在requirements.txt 以及requirements-build.txt文件
rellu本身只适用于python 3.6或从不适用,但它所使用的项目 with自然也支持较旧的Python版本rellu已开发 在Linux上测试过,但在OSX上也应该运行得很好。使用它 Windows可能可以工作,但不受测试或支持
必需的项目设置
要自动生成发行说明,发行追踪器必须 使用以下规则进行配置:
- 里程碑必须与项目版本匹配,并使用格式v1.2或v1.2.1。
- 必须使用提供的实用程序配置标签。
- 里程碑和标签必须一致使用:
- 有效问题的类型必须定义为标签bug,enhancement 或task任务类型的问题不包含在发行说明中。
- 问题应该有优先权。请参阅各种prio-标签
- 属于某个里程碑的问题应该设置该里程碑。
- 包含在某些预览版本中的问题应具有匹配的 标签集(例如a1,b2,rc3)。