Merge pull request #26 from abema/delete-description

Delete description param
abema · Jun 20, 2023 · 2927ee8 · 2927ee8
2 parents 8073d49 + 33b20fe
commit 2927ee8
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -30,11 +30,11 @@ allprojects {
 ```groovy
 dependencies {
     // Flagfit
-    implementation 'com.github.abema.flagfit:flagfit:1.1.0'
+    implementation 'com.github.abema.flagfit:flagfit:1.1.1'
     // Flagfit flagtype
-    implementation 'com.github.abema.flagfit:flagfit-flagtype:1.1.0'
+    implementation 'com.github.abema.flagfit:flagfit-flagtype:1.1.1'
     // Flagfit lint
-    lintChecks 'com.github.abema.flagfit:flagfit-lint:1.1.0'
+    lintChecks 'com.github.abema.flagfit:flagfit-lint:1.1.1'
 }
 ```
 
@@ -53,7 +53,6 @@ interface FlagService {
     )
     @FlagType.Experiment(
       owner = "{GitHub UserId}",
-      description = "The flag for this is FeatureFlag for awesome features!",
       // If the flag expires, the lint will warn you.
       expiryDate = "2023-06-13"
     )
@@ -368,7 +367,7 @@ We develop by switching these flags.
 We use the `@WorkInProgress` as Release Toggles when we first start development.  
 If the flag using this `@FlagType.WorkInProgress` is used properly, even if the feature is released, **the false value will be used fixedly**, so the function will not be released by mistake.
 
-When using FlagType, please set `owner`, `description` and `expiryDate`. [Please see section](./README.md#Lint-check-based-on-expiration-date)
+When using FlagType, please set `owner` and `expiryDate`. [Please see section](./README.md#Lint-check-based-on-expiration-date)
 
 ```kotlin
 @BooleanFlag(
@@ -377,7 +376,6 @@ When using FlagType, please set `owner`, `description` and `expiryDate`. [Please
 )
 @FlagType.WorkInProgress(
   owner = "{GitHub UserId}",
-  description = "The flag for this is FeatureFlag for awesome features!",
   expiryDate = "2023-06-13"
 )
 fun awesomeFeatureEnabled(): Boolean
@@ -393,7 +391,6 @@ So we use `@FlagType.Experiment`. With it, you can use any flag management tool,
 )
 @FlagType.Experiment(
   owner = "{GitHub UserId}",
-  description = "The flag for this is FeatureFlag for awesome features!",
   expiryDate = "2023-06-13"
 )
 fun awesomeFeatureEnabled(): Boolean
@@ -411,15 +408,13 @@ Since `@FlagType.Ops` and `@FlagType.Permission` may be operated indefinitely, t
 )
 @FlagType.Ops(
   owner = "{GitHub UserId}",
-  description = "The flag for this is FeatureFlag for awesome features!"
 )
 fun awesomeFeatureEnabled(): Boolean
 ```
 
 There may be cases where you do not know the owner or do not want to intentionally generate an error due to not setting a property. In such cases, please set the value as follows
 
 ```kotlin
-import tv.abema.flagfit.FlagfitDeprecatedParams.DESCRIPTION_NOT_DEFINED
 import tv.abema.flagfit.FlagfitDeprecatedParams.EXPIRY_DATE_NOT_DEFINED
 import tv.abema.flagfit.FlagfitDeprecatedParams.OWNER_NOT_DEFINED
 
@@ -429,7 +424,6 @@ import tv.abema.flagfit.FlagfitDeprecatedParams.OWNER_NOT_DEFINED
 )
 @FlagType.WorkInProgress(
   owner = OWNER_NOT_DEFINED,
-  description = DESCRIPTION_NOT_DEFINED,
   expiryDate = EXPIRY_DATE_NOT_DEFINED
 )
 fun awesomeUnknownFeatureEnabled(): Boolean
@@ -470,8 +464,8 @@ val flagfit = Flagfit(
 Flags that have passed their expiration date or are scheduled to expire within the next 7 days will be displayed as warnings in the IDE.
 | Explanation | Image |
 |-----|-----|
-|When the flag is about to expire|<img width="791" alt="soon" src="https://github.com/abema/flagfit/assets/51113946/8e2d47d1-1c2f-4d9d-a24c-f8481fd4d529">|
-|When the flag has expired|<img width="632" alt="expired" src="https://github.com/abema/flagfit/assets/51113946/06d561ca-b650-4274-a077-a092cad0add8">|
+|When the flag is about to expire|<img width="799" alt="soon" src="https://github.com/abema/flagfit/assets/51113946/7fc78bd3-54ba-44c5-9433-9531563b1388">|
+|When the flag has expired|<img width="687" alt="expired" src="https://github.com/abema/flagfit/assets/51113946/804e49b8-1555-413e-9455-f6bf21b6e622">|
 
 
 ### Automatic issue creation via workflow

diff --git a/flagfit-flagtype/src/main/java/tv/abema/flagfit/FlagType.kt b/flagfit-flagtype/src/main/java/tv/abema/flagfit/FlagType.kt
@@ -10,7 +10,6 @@ class FlagType {
    */
   annotation class WorkInProgress(
     val owner: String,
-    val description: String,
     val expiryDate: String,
   )
 
@@ -21,7 +20,6 @@ class FlagType {
    */
   annotation class Experiment(
     val owner: String,
-    val description: String,
     val expiryDate: String,
   )
 
@@ -32,7 +30,6 @@ class FlagType {
    */
   annotation class Ops(
     val owner: String,
-    val description: String,
     val expiryDate: String = "",
   )
 
@@ -43,7 +40,6 @@ class FlagType {
    */
   annotation class Permission(
     val owner: String,
-    val description: String,
     val expiryDate: String = "",
   )
 

diff --git a/flagfit-flagtype/src/main/java/tv/abema/flagfit/FlagfitDeprecatedParams.kt b/flagfit-flagtype/src/main/java/tv/abema/flagfit/FlagfitDeprecatedParams.kt
@@ -4,9 +4,6 @@ object FlagfitDeprecatedParams {
   @Deprecated("Flag with no assigned owner")
   const val OWNER_NOT_DEFINED = "OWNER_NOT_DEFINED"
 
-  @Deprecated("Flag without a description")
-  const val DESCRIPTION_NOT_DEFINED = "DESCRIPTION_NOT_DEFINED"
-
   @Deprecated("Flag without an expiry date")
   const val EXPIRY_DATE_NOT_DEFINED = "EXPIRY_DATE_NOT_DEFINED"
 }
diff --git a/flagfit-lint/src/test/java/tv/abema/flagfit/DeadlineExpiredDetectorText.kt b/flagfit-lint/src/test/java/tv/abema/flagfit/DeadlineExpiredDetectorText.kt
@@ -39,7 +39,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
       class FlagType {
         annotation class Experiment(
           val owner: String,
-          val description: String,
           val expiryDate: String,
         )
       }
@@ -53,9 +52,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
         @Deprecated("Flag with no assigned owner")
         const val OWNER_NOT_DEFINED = "OWNER_NOT_DEFINED"
       
-        @Deprecated("Flag without a description")
-        const val DESCRIPTION_NOT_DEFINED = "DESCRIPTION_NOT_DEFINED"
-      
         @Deprecated("Flag without an expiry date")
         const val EXPIRY_DATE_NOT_DEFINED = "EXPIRY_DATE_NOT_DEFINED"
       }
@@ -82,7 +78,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Experiment(
                 owner = "Hoge Fuga",
-                description = "hogehoge",
                 expiryDate = "2023-06-01"
               )
               fun awesomeExperimentFeatureEnabled(): Boolean
@@ -127,7 +122,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Experiment(
                 owner = "Hoge Fuga",
-                description = "hogehoge",
                 expiryDate = "2023-06-01",
               )
               fun awesomeExperimentFeatureEnabled(): Boolean
@@ -172,7 +166,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Experiment(
                 owner = "Hoge Fuga",
-                description = "hogehoge",
                 expiryDate = "2023-06-01",
               )
               fun awesomeExperimentFeatureEnabled(): Boolean
@@ -200,12 +193,10 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
           class FlagType {
             annotation class Ops(
               val owner: String,
-              val description: String,
               val expiryDate: String = "",
             )
             annotation class Permission(
               val owner: String,
-              val description: String,
               val expiryDate: String = "",
             )
           }
@@ -224,7 +215,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Ops(
                 owner = "Hoge Fuga",
-                description = "hogehoge"
               )
               fun awesomeOpsFeatureEnabled(): Boolean
               @BooleanFlag(
@@ -233,7 +223,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Permission(
                 owner = "Hoge Fuga",
-                description = "hogehoge"
               )
               fun awesomePermissionFeatureEnabled(): Boolean
           }
@@ -274,7 +263,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Experiment(
                 owner = "Hoge Fuga",
-                description = "hogehoge",
                 expiryDate = "2023-06-01",
               )
               fun awesomeVariationFeatureEnabled(): Boolean
@@ -313,7 +301,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
           import tv.abema.flagfit.FlagType
           import tv.abema.flagfit.annotation.BooleanFlag
           import tv.abema.flagfit.FlagfitDeprecatedParams.OWNER_NOT_DEFINED
-          import tv.abema.flagfit.FlagfitDeprecatedParams.DESCRIPTION_NOT_DEFINED
           import tv.abema.flagfit.FlagfitDeprecatedParams.EXPIRY_DATE_NOT_DEFINED
           
           interface Example {
@@ -323,7 +310,6 @@ class DeadlineExpiredDetectorText : LintDetectorTest() {
               )
               @FlagType.Experiment(
                 owner = OWNER_NOT_DEFINED,
-                description = DESCRIPTION_NOT_DEFINED,
                 expiryDate = EXPIRY_DATE_NOT_DEFINED,
               )
               fun awesomeOpsFeatureEnabled(): Boolean

diff --git a/sample-android/src/main/java/tv/abema/fragfit/SampleFlagService.kt b/sample-android/src/main/java/tv/abema/fragfit/SampleFlagService.kt
@@ -1,7 +1,6 @@
 package tv.abema.fragfit
 
 import tv.abema.flagfit.FlagType
-import tv.abema.flagfit.FlagfitDeprecatedParams.DESCRIPTION_NOT_DEFINED
 import tv.abema.flagfit.FlagfitDeprecatedParams.EXPIRY_DATE_NOT_DEFINED
 import tv.abema.flagfit.FlagfitDeprecatedParams.OWNER_NOT_DEFINED
 import tv.abema.flagfit.JustFlagSource
@@ -17,7 +16,6 @@ interface SampleFlagService {
   )
   @FlagType.WorkInProgress(
     owner = "Hoge Fuga",
-    description = "hogehoge",
     expiryDate = "2022-12-30"
   )
   fun awesomeWipFeatureEnabled(): Boolean
@@ -28,7 +26,6 @@ interface SampleFlagService {
   )
   @FlagType.Experiment(
     owner = "Hoge Fuga",
-    description = "hogehoge",
     expiryDate = "2322-12-30"
   )
   fun awesomeExperimentFeatureEnabled(): Boolean
@@ -39,7 +36,6 @@ interface SampleFlagService {
   )
   @FlagType.Ops(
     owner = "Hoge Fuga",
-    description = "hogehoge"
   )
   fun awesomeOpsFeatureEnabled(): Boolean
 
@@ -49,7 +45,6 @@ interface SampleFlagService {
   )
   @FlagType.Permission(
     owner = "Hoge Fuga",
-    description = "hogehoge",
     expiryDate = "2022-12-30"
   )
   fun awesomePermissionFeatureEnabled(): Boolean
@@ -60,7 +55,6 @@ interface SampleFlagService {
   )
   @FlagType.WorkInProgress(
     owner = OWNER_NOT_DEFINED,
-    description = DESCRIPTION_NOT_DEFINED,
     expiryDate = EXPIRY_DATE_NOT_DEFINED
   )
   fun awesomeUnknownFeatureEnabled(): Boolean