跳转到主要内容

DKIST上ViSP仪器科学处理代码

项目描述

概述

dkist-processing-visp库包含visp管道的实现,作为dkist-processing-core框架和dkist-processing-common任务的集合。

建议的项目结构是将任务和工作流程分开到不同的包中。将工作流程放在自己的包中可以方便使用build_utils在单元测试中测试这些工作流程的完整性。

校准管道

构建

工件通过Bitbucket Pipelines构建。

此管道可用于其他仓库,只需修改包和工件位置即可使用与目标仓库相关的名称。

例如:dkist-processing-test -> dkist-processing-vbi 和 dkist_processing_test -> dkist_processing_vbi

部署

部署使用turtlebot进行,并遵循dkist-processing-core中详细说明的过程。

环境变量

只有dkist-processing-coredkist-processing-common指定的。

开发

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

变更日志

当您对此存储库进行任何更改时,必须附带变更日志文件。此存储库的变更日志使用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

科学更改日志

每当发布涉及L1数据科学质量的变化时,应创建额外的更改日志片段。这些片段旨在尽可能详细,以准确捕获更改的范围,因此请随时使用所有复杂的RST。科学片段放置在与其他片段相同的changelog/目录中,但始终称为

<PR NUMBER | +>.science[.<COUNTER>].rst

如果单个拉取请求封装了整个科学更改,则第一个字段应该是该PR编号(与正常的CHANGELOG相同)。如果没有简单地将单个PR映射到科学更改,则使用字符“+”代替;这将创建一个没有相关PR的更改日志条目。例如

$ ls changelog/
99.bugfix.rst    # This is a normal changelog fragment associated with a bugfix in PR 99
99.science.rst   # Apparently that bugfix also changed the scientific results, so that PR also gets a science fragment
+.science.rst    # This fragment is not associated with a PR

在构建SCIENCE_CHANGELOG时,请使用此存储库中的science_towncrier.sh脚本来执行此操作。此脚本接受默认towncrier的所有相同参数。例如

./science_towncrier.sh build --version vx.y.z

这将更新SCIENCE_CHANGELOG并从更改日志目录中删除任何科学片段。

项目详细信息


发布历史记录 发布通知 | RSS源

下载文件

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

源分布

dkist_processing_visp-2.19.1.tar.gz (468.3 kB 查看哈希值)

上传时间

支持