Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
  • 何か問題がありますか？
#815 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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時間
マージ済み PR（30日）
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nextcloud/helm のほかの issue

nextcloud/helm の issue をすべて見る

似ている issue

DevOps の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。