chore: Rename AUTH_KEY to PRIVATE_KEY to make it clearer

Author: nthState-Chris

README.md

@@ -18,12 +18,12 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Run custom action
+      - name: Upload Release Notes to TestFlight
         uses: nthState/UploadTestFlightReleaseNotes
         with:
           ISSUER_ID: ${{ secrets.APPCONNECT_API_ISSUER }}
           KEY_ID: ${{ secrets.APPCONNECT_API_KEY_ID }}
-          AUTH_KEY: ${{ secrets.APPCONNECT_API_KEY_PRIVATE }}
+          PRIVATE_KEY: ${{ secrets.APPCONNECT_API_KEY_PRIVATE }}
           APP_ID: id of the app
           WHATS_NEW: "detail item that has changed"
           BUILD_NUMBER: the build number you want to change
@@ -34,9 +34,23 @@ jobs:
 
 ### Docker
 
+Build the docker
+
 ```bash
 docker build . -t githubactiontest -f Dockerfile
-docker run -e ISSUER_ID=a -e KEY_ID=a -e AUTH_KEY=a -e APP_ID=a -e WHATS_NEW=a -e BUILD_NUMBER=a -d githubactiontest
+```
+
+Run the docker
+
+```bash
+docker run \
+-e ISSUER_ID=appstore connect api issuer id \
+-e KEY_ID=appstore connect api key id \
+-e PRIVATE_KEY=appstore connect api private key  \
+-e APP_ID=app id \
+-e WHATS_NEW="Your update text, max 4000 chars" \
+-e BUILD_NUMBER= your build number \
+-d githubactiontest
 ```
 
 

action.yml

@@ -7,8 +7,8 @@ inputs:
   KEY_ID:
     description: 'Key ID from AppStore Connect'
     required: true
-  AUTH_KEY:
-    description: 'Auth Key from AppStore Connect'
+  PRIVATE_KEY:
+    description: 'Private Key from AppStore Connect'
     required: true
   APP_ID:
     description: 'App ID from AppStore Connect'

main.py

@@ -7,7 +7,7 @@
 
 class UploadTestFlightReleaseNotes:
 
-	def generateToken(self, issuer_id, key_id, auth_key):
+	def generateToken(self, issuer_id, key_id, private_key):
 
 		current_time = datetime.datetime.now(datetime.timezone.utc)
 		unix_timestamp = current_time.timestamp()
@@ -22,7 +22,7 @@ def generateToken(self, issuer_id, key_id, auth_key):
 
 		headers = {'kid': key_id}
 
-		encoded_token = jwt.encode(data, auth_key, algorithm='ES256', headers=headers)
+		encoded_token = jwt.encode(data, private_key, algorithm='ES256', headers=headers)
 
 		return encoded_token
 
@@ -79,14 +79,14 @@ def main():
 
 	issuer_id = os.getenv('ISSUER_ID')
 	key_id = os.getenv('KEY_ID')
-	auth_key = os.getenv('AUTH_KEY')
+	private_key = os.getenv('PRIVATE_KEY')
 
 	app_id = os.getenv('APP_ID')
 	whats_new = os.getenv('WHATS_NEW')
 	build_number = os.getenv('BUILD_NUMBER')
 
 	service = UploadTestFlightReleaseNotes()
-	token = service.generateToken(issuer_id, key_id, auth_key)
+	token = service.generateToken(issuer_id, key_id, private_key)
 	reason = service.uploadNotes(app_id, token, whats_new, build_number)
 
 	print(reason)

requirements.txt

@@ -1,12 +1,9 @@
-beautifulsoup4==4.12.3
 certifi==2024.2.2
 cffi==1.16.0
 charset-normalizer==3.3.2
 cryptography==42.0.7
 idna==3.7
-Markdown==3.6
 pycparser==2.22
 PyJWT==2.8.0
 requests==2.32.3
-soupsieve==2.5
 urllib3==2.2.1