Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Feature: Enforce conventional commits and use it to set ArtifactHub.io annotations

未关闭
  • 哪里不对？
#815 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
bash, git, github-actions, kubernetes, python
领域
ci-cd, devops, release

调研方向

先从 Helm Chart 文件和 GitHub Actions 发布工作流开始，然后查看 issue 中链接的 conventional commits 和 ArtifactHub 注解格式。比较 Python 和 Bash 示例，并在选择方案之前确定仓库的发布节点。完成的标准是提交已通过验证，并且发布版本包含所请求的 ArtifactHub 注解和 issue 链接。

由索引模型根据 Issue 内容生成。

描述

enhancement

Feature

Artifact Hub supports annotations in the Helm Chart file. This allows additional information to be provided to users.

Changes

Changes can be summarized and defined as annotation. This can be archived via artifacthub.io/changes.

annotations:
  artifacthub.io/changes: |
  - kind: added
    description: Cool feature
    links:
    - name: GitHub Issue
      url: https://github.com/issue-url
    - name: GitHub PR
      url: https://github.com/pr-url

This would provide a changelog on ArtifactHub.io. Subscribers to the chart will be informed of the changes in an email sent by ArtifactHub.io when a new version is released. Similar to the changelog on the ArtifactHub.io website. The figure below shows the changelogs provided by the Gitea project.

Image
Forward to GitHub Issues

Furthermore, an URL can be defined to forward users from ArtifactHub.io to GitHub issues if they want to report an issue:

annotations:
  artifacthub.io/links: |
  - name: support
    url: https://github.com/nextcloud/helm/issues

I think this is a great feature for directing users to the right place to report bugs. ArtifactHub.io then displays a special badge on your website with the name Report Issue.

Image
Further annotations

A complete list of supported annotations and the structure can be found on their website.

Implementation

conventional commits

I think the API is clear. The annotations must be set in the chart. Except for the changelog, this should also be quite simple.

For the changelog, however, a diff between the last and current release must be created for each release. Based on the git commits, a changelog must be generated and defined as an annotation in the specified format.

Therefore, I propose introducing conventional commits so that the git changelog can be parsed. I think conventional commits have already become established among many developers and should therefore cause less pain. It is advisable to extend the CI and throw an error if conventional commits are ignored.

I'm completely open-minded when it comes to tools, but based on my experience, I would suggest commitlint. As I mentioned above, my colleagues and I have been using Gitea for quite some time now. The corresponding configuration can be found in the project under .commitlintrc.

add changelog annotation

Currently, I don't know of any tool that can be easily integrated into GitHub Actions to add the annotation. For this reason, there are approaches to solve this using Python, as is done in the x509-certificate exporter, or using a Bash script with the help of yq in the Gitea project.

I have no preference. Once the data basis for conventional commits is available, it should be no problem to generate a changelog from it.

upload changelog

Once the changelog is available, it can also be used optionally to generate a release.

Conclusion

I look forward to your feedback. Please interpret the Implementation section as an example only, to gather ideas and inspiration.

Volker

主要语言
Go Template
星标
536
派生
316
平均合并
4 天 16 小时
30 天内合并 PR
2

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

nextcloud/helm 的其他 Issue

查看 nextcloud/helm 的全部 Issue

相似的 Issue

更多 DevOps Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。