some changes

Thomas Desplaces · Thomas Desplaces · commit d69e3ea759e9 · 2023-01-24T16:57:57.000+01:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,10 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-xml
+    -   id: check-json
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: detect-private-key
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+0.0.1 - 2023-01-24
+===================
+
+### Features
+- Add CHANGELOG.md.
+- Add MAINTAINERS.md.
+- Add pre-commit file.
+
+### Updating
+- Update README : delete Author and version informations.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -0,0 +1 @@
+- [@thomasdesplaces](https://github.com/thomasdesplaces)
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 [![Apigee](https://upload.wikimedia.org/wikipedia/commons/a/aa/Apigee_logo.svg)](https://cloud.google.com/apigee)
 
+![alt version](https://img.shields.io/badge/Version-0.0.1-violet)
+![alt production](https://img.shields.io/badge/Production--Ready-No-green)
+![alt docker](https://img.shields.io/badge/Deployment_tool-Maven-orange)
+
 This is a code to deploy sharedflows which are used when your backend is secured by GCP OAuth (via Service Account) or IAP (via Service Account).
 
 ## Prerequisite
@@ -30,12 +34,3 @@ How to use it :
 cd sharedflows/gcp-token-oauth
 mvn install -P=dev -Dusername=XXXX -Dpassword=YYYY -Dorganization=ZZZZ
 ```
-
-## Versions
-
-**Last version :** 1.0
-
-## Auteurs
-
-* **Thomas** _alias_ [@tonyglandyl](https://github.com/tonyglandyl28)
-
diff --git a/sharedflows/gcp-token-iap/README.md b/sharedflows/gcp-token-iap/README.md
@@ -7,7 +7,7 @@ Once the token has been retrieved, then it is cached for the duration defined in
 [Documentation Google](https://developers.google.com/identity/protocols/oauth2/service-account)
 
 ## Pré-requis
-Lors de l'utilisation de ce sharedflow dans un proxy il faut d'abord prévoir :
+When using this sharedflow in a proxy you must first provide :
 
 - A service account that has the rights to call an API on GCP via IAP
 - The JSON of this service account
@@ -65,4 +65,4 @@ This policy caches the value of the _google-credentials.access-token_ variable i
 - Environment name
 - Proxy name
 - Revision number
-- Target name
+- Target name
diff --git a/sharedflows/gcp-token-iap/env/dev/caches.json b/sharedflows/gcp-token-iap/env/dev/caches.json
@@ -9,4 +9,4 @@
           "valuesNull": false
       }
     }
-  ]
+  ]
diff --git a/sharedflows/gcp-token-iap/env/prd/caches.json b/sharedflows/gcp-token-iap/env/prd/caches.json
@@ -9,4 +9,4 @@
           "valuesNull": false
       }
     }
-  ]
+  ]
diff --git a/sharedflows/gcp-token-iap/env/test/caches.json b/sharedflows/gcp-token-iap/env/test/caches.json
@@ -9,4 +9,4 @@
           "valuesNull": false
       }
     }
-  ]
+  ]
diff --git a/sharedflows/gcp-token-iap/pom.xml b/sharedflows/gcp-token-iap/pom.xml
@@ -13,4 +13,4 @@
     <name>gcp-token-oauth</name>
     <version>1.0</version>
     <packaging>pom</packaging>
-</project>
+</project>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/am.add-authorization.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/am.add-authorization.xml
@@ -7,4 +7,4 @@
         </Headers>
     </Add>
     <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
-</AssignMessage>
+</AssignMessage>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/ev.extract-json.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/ev.extract-json.xml
@@ -8,4 +8,4 @@
     </JSONPayload>
     <Source clearPayload="false">callout-token</Source>
     <VariablePrefix>google-credentials</VariablePrefix>
-</ExtractVariables>
+</ExtractVariables>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/gjwt.generate-JWT.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/gjwt.generate-JWT.xml
@@ -11,4 +11,4 @@
         <Claim name="scope" type="string" ref="private.iap-id" />
     </AdditionalClaims>
     <OutputVariable>output_jwt</OutputVariable>
-</GenerateJWT>
+</GenerateJWT>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/js.extract-credentials.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/js.extract-credentials.xml
@@ -5,8 +5,8 @@
     <Source>
         var c = context.getVariable('private.credentialsjson');
         c = JSON.parse(c);
-        for (var prop in c) { 
+        for (var prop in c) {
           context.setVariable('private.' + prop, c[prop]);
         }
     </Source>
-</Javascript>
+</Javascript>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/kvm.gcp-service-account.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/kvm.gcp-service-account.xml
@@ -8,4 +8,4 @@
             <Parameter>credentials</Parameter>
         </Key>
     </Get>
-</KeyValueMapOperations>
+</KeyValueMapOperations>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/lc.gcp-token.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/lc.gcp-token.xml
@@ -10,4 +10,4 @@
         <KeyFragment ref="target.name"/>
     </CacheKey>
     <AssignTo>google-credentials.id-token</AssignTo>
-</LookupCache>
+</LookupCache>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/pc.gcp-token.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/pc.gcp-token.xml
@@ -10,4 +10,4 @@
         <KeyFragment ref="target.name"/>
     </CacheKey>
     <Source>google-credentials.id-token</Source>
-</PopulateCache>
+</PopulateCache>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/policies/sc.gcp-oauth.xml b/sharedflows/gcp-token-iap/sharedflowbundle/policies/sc.gcp-oauth.xml
@@ -22,4 +22,4 @@
             <Enabled>true</Enabled>
         </SSLInfo>
     </HTTPTargetConnection>
-</ServiceCallout>
+</ServiceCallout>
diff --git a/sharedflows/gcp-token-iap/sharedflowbundle/sharedflows/default.xml b/sharedflows/gcp-token-iap/sharedflowbundle/sharedflows/default.xml
@@ -29,4 +29,4 @@
     <Step>
         <Name>pc.gcp-token</Name>
     </Step>
-</SharedFlow>
+</SharedFlow>
diff --git a/sharedflows/gcp-token-oauth/README.md b/sharedflows/gcp-token-oauth/README.md
@@ -65,4 +65,4 @@ This policy caches the value of the _google-credentials.access-token_ variable i
 - Environment name
 - Proxy name
 - Revision number
-- Target name
+- Target name
diff --git a/sharedflows/gcp-token-oauth/env/dev/caches.json b/sharedflows/gcp-token-oauth/env/dev/caches.json
@@ -9,4 +9,4 @@
           "valuesNull": false
       }
     }
-  ]
+  ]
diff --git a/sharedflows/gcp-token-oauth/env/prd/caches.json b/sharedflows/gcp-token-oauth/env/prd/caches.json
@@ -9,4 +9,4 @@
           "valuesNull": false
       }
     }
-  ]
+  ]
diff --git a/sharedflows/gcp-token-oauth/env/test/caches.json b/sharedflows/gcp-token-oauth/env/test/caches.json
@@ -9,4 +9,4 @@
           "valuesNull": false
       }
     }
-  ]
+  ]
diff --git a/sharedflows/gcp-token-oauth/pom.xml b/sharedflows/gcp-token-oauth/pom.xml
@@ -13,4 +13,4 @@
     <name>gcp-token-oauth</name>
     <version>1.0</version>
     <packaging>pom</packaging>
-</project>
+</project>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/am.add-authorization.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/am.add-authorization.xml
@@ -7,4 +7,4 @@
         </Headers>
     </Add>
     <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
-</AssignMessage>
+</AssignMessage>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/ev.extract-json.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/ev.extract-json.xml
@@ -8,4 +8,4 @@
     </JSONPayload>
     <Source clearPayload="false">callout-token</Source>
     <VariablePrefix>google-credentials</VariablePrefix>
-</ExtractVariables>
+</ExtractVariables>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/gjwt.generate-JWT.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/gjwt.generate-JWT.xml
@@ -11,4 +11,4 @@
         <Claim name="scope" type="string">https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/userinfo.email</Claim>
     </AdditionalClaims>
     <OutputVariable>output_jwt</OutputVariable>
-</GenerateJWT>
+</GenerateJWT>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/js.extract-credentials.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/js.extract-credentials.xml
@@ -5,8 +5,8 @@
     <Source>
         var c = context.getVariable('private.credentialsjson');
         c = JSON.parse(c);
-        for (var prop in c) { 
+        for (var prop in c) {
           context.setVariable('private.' + prop, c[prop]);
         }
     </Source>
-</Javascript>
+</Javascript>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/kvm.gcp-service-account.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/kvm.gcp-service-account.xml
@@ -8,4 +8,4 @@
             <Parameter>credentials</Parameter>
         </Key>
     </Get>
-</KeyValueMapOperations>
+</KeyValueMapOperations>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/lc.gcp-token.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/lc.gcp-token.xml
@@ -10,4 +10,4 @@
         <KeyFragment ref="target.name"/>
     </CacheKey>
     <AssignTo>google-credentials.access-token</AssignTo>
-</LookupCache>
+</LookupCache>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/pc.gcp-token.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/pc.gcp-token.xml
@@ -10,4 +10,4 @@
         <KeyFragment ref="target.name"/>
     </CacheKey>
     <Source>google-credentials.access-token</Source>
-</PopulateCache>
+</PopulateCache>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/policies/sc.gcp-oauth.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/policies/sc.gcp-oauth.xml
@@ -22,4 +22,4 @@
             <Enabled>true</Enabled>
         </SSLInfo>
     </HTTPTargetConnection>
-</ServiceCallout>
+</ServiceCallout>
diff --git a/sharedflows/gcp-token-oauth/sharedflowbundle/sharedflows/default.xml b/sharedflows/gcp-token-oauth/sharedflowbundle/sharedflows/default.xml
@@ -29,4 +29,4 @@
     <Step>
         <Name>pc.gcp-token</Name>
     </Step>
-</SharedFlow>
+</SharedFlow>
diff --git a/sharedflows/sharedflow-shared-pom.xml b/sharedflows/sharedflow-shared-pom.xml
@@ -78,7 +78,7 @@
                 <executions>
                     <execution>
                         <id>create-config-cache</id>
-                        <phase>package</phase>                        
+                        <phase>package</phase>
                         <goals>
                             <goal>caches</goal>
                         </goals>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+- [@thomasdesplaces](https://github.com/thomasdesplaces)`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,4 @@`
`9`	`9`	`"valuesNull": false`
`10`	`10`	`}`
`11`	`11`	`}`
`12`		`- ]`
	`12`	`+ ]`