Merge pull request #3 from tspascoal/add-expiration-to-output

Add tokenExpiration as an output variable

Author: tspascoal

README.md

@@ -78,8 +78,9 @@ steps:
 
 | Variable | Description |
 |----------|-------------|
-| $(installationToken) | The generated GitHub App installation token |
-| $(installationId) | The ID of the GitHub App installation |
+| installationToken | The generated GitHub App installation token |
+| installationId | The ID of the GitHub App installation |
+| tokenExpiration | The expiration date and time of the generated token (ISO 8601 format) |
 
 ### Service Connection Setup (optional)
 

create-github-app-token/src/core/github-service.ts

@@ -135,9 +135,10 @@ export class GitHubService {
      * It logs details about the token creation process, including repository selection and permissions.
      * The token is scoped based on the provided repositories or the entire installation if no repositories are specified.
      */
-    async getInstallationToken(jwtToken: string, installationId: number, repositories: string[] = [], permissions?: { [key: string]: string }): Promise<string> {
+    async getInstallationToken(jwtToken: string, installationId: number, repositories: string[] = [], permissions?: { [key: string]: string }): Promise<{ token: string; expiresAt: string }> {
         let groupName = '';
         let token = '';
+        let expiresAt = '';
         if (repositories.length > 0) {
             groupName = `##[group]Create installation token for repositories: ${repositories} with ${installationId}`;
         } else {
@@ -167,10 +168,11 @@ export class GitHubService {
             );
 
             token = response.data.token;
+            expiresAt = response.data.expires_at;
 
             this.dumpHeaders(response.headers);
 
-            tl.debug(`Expires: ${response.data.expires_at}`);
+            tl.debug(`Expires: ${expiresAt}`);
             console.log(`Repository selection: ${response.data.repository_selection}`);
             const permissionsCsv = this.formatPermissions(response.data.permissions);
             console.log(`Permissions: ${permissionsCsv}`);
@@ -179,7 +181,7 @@ export class GitHubService {
             console.log('##[endgroup]')
         }
 
-        return token;
+        return { token, expiresAt };
     }
 
     async revokeInstallationToken(token: string): Promise<boolean> {

create-github-app-token/src/tasks/run.ts

@@ -169,12 +169,13 @@ async function run() {
     const installationId = await githubService.getInstallationId(jwtToken, owner, isOrg, repositories);
     console.log(`Found installation ID: ${installationId}`);
 
-    const token = await githubService.getInstallationToken(jwtToken, installationId, repositories, permissions);
+    const { token, expiresAt } = await githubService.getInstallationToken(jwtToken, installationId, repositories, permissions);
     console.log('Installation token generated successfully');
 
     // Set the output variables
     tl.setVariable(constants.INSTALLATIONID_OUTPUT_VARNAME, installationId.toString(), false);
     tl.setVariable(constants.INSTALLATION_TOKEN_OUTPUT_VARNAME, token, true); // secret
+    tl.setVariable(constants.TOKEN_EXPIRATION_OUTPUT_VARNAME, expiresAt, false);
 
     // Save state for post job
     tl.setTaskVariable(constants.INSTALLATION_TOKEN_OUTPUT_VARNAME, token, true); // secret

create-github-app-token/src/utils/constants.ts

@@ -3,6 +3,7 @@ export const JWT_EXPIRATION = 10 * 60; // 10 minutes in seconds (max is 10 minut
 
 export const INSTALLATIONID_OUTPUT_VARNAME = 'installationId';
 export const INSTALLATION_TOKEN_OUTPUT_VARNAME = 'installationToken';
+export const TOKEN_EXPIRATION_OUTPUT_VARNAME = 'tokenExpiration';
 export const SKIP_TOKEN_TASK_VARNAME = 'skipTokenRevoke';
 export const BASE_URL_TASK_VARNAME = 'baseUrl';
 

create-github-app-token/task.json

@@ -10,7 +10,7 @@
     "version": {
         "Major": 1,
         "Minor": 0,
-        "Patch": 2
+        "Patch": 3
     },
     "instanceNameFormat": "Create GitHub App Installation Token",
     "inputs": [
@@ -91,6 +91,10 @@
         {
             "name": "installationId",
             "description": "The ID of the GitHub App installation"
+        },
+        {
+            "name": "tokenExpiration",
+            "description": "The expiration date and time of the generated token (ISO 8601 format)"
         }
     ],
     "execution": {

vss-extension.json

@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "create-github-app-token",
     "name": "GitHub App Token Generator",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "publisher": "INSERT YOUR PUBLISHER HERE",
     "public": false,
     "targets": [