Fix misleading `getDesiredResourceTags` behavior

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
java
領域
backend

調査の方向性

src/main/java/software/amazon/cloudformation/AbstractWrapper.java の536-549行目を読み、次に request.getRequestData().getSystemTags() を調べてタグのソースを比較します。既存の動作をドキュメント化すべきか、ユーザータグのみを扱うメソッドの背後に分離すべきかを判断します。完了条件は、APIによるシステムタグの扱いが明確になることです。

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

説明

https://github.com/aws-cloudformation/cloudformation-cli-java-plugin/blob/75133adfd5b82c347bf31579b09e82750b47cde7/src/main/java/software/amazon/cloudformation/AbstractWrapper.java#L536-L549

Here we claim getDesiredResourceTags return User-defined tags. Intuitively readers would assume it's for user tags only.

However, I have noticed system tags such as aws:cloudformation:stackid is being added in the returned results while testing my CFN stack. Given we already have request.getRequestData().getSystemTags() method for system tags, please consider to either update the code comments explaining why these non User-defined tags are here, or provide another method that will only return user tags to avoid confusions.

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

環境構築

はじめの一歩

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

aws-cloudformation/cloudformation-cli-java-plugin のほかの issue

aws-cloudformation/cloudformation-cli-java-plugin の issue をすべて見る

似ている issue

Java の issue をもっと見る

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

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