跳转到主要内容

PA&C 管道

项目描述

模块,用于确定望远镜偏振参数和计算仪器解调矩阵

它主要是一个由DKIST自动化处理管道使用的库

部署

dkist-processing-pac 已部署到 PyPI

开发

git clone git@bitbucket.org:dkistdc/dkist-processing-pac.git
cd dkist-processing-pac
pre-commit install
pip install -e .[test]
pytest -v --cov dkist_processing_pac

变更日志

当你对这个仓库进行任何更改时,它必须伴随着一个变更日志文件。这个仓库的变更日志使用towncrier包。下一个版本中变更日志的条目作为单独的文件(每个更改一个文件)添加到changelog/目录中。

编写变更日志条目

伴随一个更改的变更日志条目应该添加到changelog/目录中。这个目录中文件的名称遵循特定的模板

<PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst

字段具有以下含义

  • <PULL REQUEST NUMBER>:这是拉取请求的编号,这样人们可以从变更日志条目跳转到BitBucket上的差异。

  • <TYPE>:这是更改的类型,必须是以下描述的值之一。

  • <COUNTER>:这是一个可选字段,如果你对同一类型的更改进行了多次更改,你可以在后续更改中追加一个计数器,例如,对于同一个PR中的两个bugfix更改,使用100.bugfix.rst100.bugfix.1.rst

可能的类型列表定义在 pyproject.toml 的 towncrier 部分,类型包括

  • feature:这是一个新增的代码功能。

  • bugfix:这是一个修复错误的变更。

  • doc:文档变更。

  • removal:公共 API 的弃用或删除。

  • misc:任何不适合其他地方的小变更,例如对包基础设施的变更。

在发布时间渲染变更日志

在准备标记发布版本之前,首先必须运行 towncrier 以渲染变更日志。以下是该步骤:

  • 使用您想要标记的版本号运行 towncrier build –version vx.y.z

  • 同意让 towncrier 删除片段。

  • 添加并提交您的变更。

  • 标记发布版本。

注意:如果您忘记向已标记的发布版本添加变更日志条目(无论是手动添加还是通过 towncrier 自动添加),那么 Bitbucket 管道将失败。为了能够使用相同的标记,您必须在本地和远程分支上删除它。

# First, actually update the CHANGELOG and commit the update
git commit

# Delete tags
git tag -d vWHATEVER.THE.VERSION
git push --delete origin vWHATEVER.THE.VERSION

# Re-tag with the same version
git tag vWHATEVER.THE.VERSION
git push --tags origin main

项目详情


下载文件

下载您平台对应的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源代码分发

dkist-processing-pac-3.0.2.tar.gz (551.1 kB 查看哈希值)

上传时间 源代码

由以下支持