Add support for OCI spec annotations (and legacy LABEL)

オープン
#24 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
docker, python
領域
devops

調査の方向性

参照されている Dockerfile LABEL の例と、リンク先の OCI image-spec アノテーション一覧から始めます。リポジトリの Dockerfile およびイメージ分析のエントリーポイントを探す際は、json.txt と config.json.zip を参照入力として使用します。事前定義された OCI アノテーションとレガシー LABEL 値が一貫して認識・報告されれば完了です。

索引モデルが issue の本文から書いたものです。

説明

These can be added as LABEL from a Dockerfile https://github.com/Tekki/docker-perl-test/blob/e52c397f9daf04ca89c416b76b610da5ae1cc15a/p16/Dockerfile#L24 and were initially specified in http://label-schema.org/rc1/ and are now specified at https://github.com/opencontainers/image-spec/blob/master/annotations.md

Some key/values are predefined:
https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys :

  • org.opencontainers.image.created: date/timestamp
  • org.opencontainers.image.authors: contact details of the people or organization responsible for the image (freeform string)
  • org.opencontainers.image.url: homepage URL
  • org.opencontainers.image.documentation: documentation URL
  • org.opencontainers.image.source: VCS/download URL
  • org.opencontainers.image.version: version ideally semver and mapped to a VCS repo tag
  • org.opencontainers.image.revision: VCS revision e.g. git commit in org.opencontainers.image.source
  • org.opencontainers.image.vendor: author (e.g. created_by)
  • org.opencontainers.image.licenses: Should be an SPDX License Expression
  • org.opencontainers.image.ref.name: unclear... "Name of the reference for a target"
  • org.opencontainers.image.title: brief summary or "name" of the image?
  • org.opencontainers.image.description: long description

These are some examples:

主要言語
Python
スター
38
フォーク
12
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

aboutcode-org/container-inspector のほかの issue

aboutcode-org/container-inspector の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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