(Minor) Provide VERCEL_ALIASES_CREATED env variable (#12)

Co-authored-by: Hugo MARTIN <hugo.martin.69@gmail.com>

Author: Vadorequest

.github/workflows/run-example-deployment.yml

@@ -19,3 +19,7 @@ jobs:
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
 
       - run: "echo \"Found deployment url: ${{ env.VERCEL_DEPLOYMENT_URL }}\""
+      - run: "echo \"Created aliases ${{ env.VERCEL_ALIASES_CREATED }}\""
+      - run: "echo \"Created aliases (full) ${{ env.VERCEL_ALIASES_CREATED_FULL }}\""
+
+      - run: "echo \"Alias markdown generated: ${{ env.VERCEL_ALIASES_CREATED_URLS_MD }}\""

README.md

@@ -82,7 +82,8 @@ The below variables are available as outputs, but are also **injected as environ
 - `VERCEL_DEPLOYMENT_URL`: Full Vercel deployment url (parsed from the deployment logs), e.g: `https://xxx.vercel.app`
 - `VERCEL_DEPLOYMENT_DOMAIN`: Url without the protocol declaration, e.g: `xxx.vercel.app`
 - `VERCEL_ALIASES_ERROR`: _(optional)_ Vercel errors during domain aliasing
-
+- `VERCEL_ALIASES_CREATED`: List of aliases created successfully, as a string separated by `, ` for each alias
+- `VERCEL_ALIASES_CREATED_FULL`: List of aliases created successfully, as a JSON array containing the Vercel's response 
 > Hint: You can use `${{ env.VERCEL_DEPLOYMENT_URL }}` in you GitHub Action to read the deployment URL, after the action has run.
 
 ## :hugs: Community examples :heart:

lib/vercel.js

@@ -99,16 +99,23 @@ const createAliases = (deploymentUrl, customDeploymentFile, failIfAliasNotLinked
             core.debug(`Resolving alias promises`);
             const aliasesResponse = yield Promise.all(aliasCreationPromises);
             core.debug(`Alias creation response: ${JSON.stringify(aliasesResponse)}`);
-            if (aliasesResponse.filter((response) => response.error).length > 0) {
+            const aliasesErrors = aliasesResponse.filter((response) => response.error);
+            const aliasesSucceeded = aliasesResponse.filter((response) => !response.error);
+            if (aliasesErrors.length > 0) {
                 const failedAliases = aliasesResponse.filter((response) => response.error).map((response) => response.error);
                 const message = `Got following errors: ${JSON.stringify(failedAliases)}`;
                 failIfAliasNotLinked ? core.setFailed(message) : core.warning(message);
                 core.debug(`Exporting this error...`);
                 core.setOutput('VERCEL_ALIASES_ERROR', failedAliases);
             }
-            for (const alias of aliasesResponse.filter((response) => !response.error)) {
-                core.debug(`Created alias ${alias}`);
+            for (const aliasSuccess of aliasesSucceeded) {
+                core.debug(`Created alias "${aliasSuccess === null || aliasSuccess === void 0 ? void 0 : aliasSuccess.alias}".`);
             }
+            const aliasesUrlsMarkdown = aliasesSucceeded.map((aliasSuccess) => `[aliasSuccess.alias](https://aliasSuccess.alias)`).join(', ');
+            core.setOutput('VERCEL_ALIASES_CREATED', aliasesSucceeded);
+            core.exportVariable('VERCEL_ALIASES_CREATED', aliasesSucceeded.map((aliasSuccess) => aliasSuccess.alias).join(', '));
+            core.setOutput('VERCEL_ALIASES_CREATED_URLS_MD', aliasesUrlsMarkdown);
+            core.exportVariable('VERCEL_ALIASES_CREATED_URLS_MD', aliasesUrlsMarkdown);
         }
         else {
             core.warning(`No "alias" key found in ${vercelConfigFile}`);
@@ -118,7 +125,7 @@ const createAliases = (deploymentUrl, customDeploymentFile, failIfAliasNotLinked
         core.setFailed(`You asked to link aliases but we cannot access to vercel config file "${vercelConfigFile}". Deployment succeeded but no aliases has been created.`);
     }
 });
-const deploy = (command, deployAlias, failIfAliasNotLinked) => __awaiter(void 0, void 0, void 0, function* () {
+const deploy = (command, applyDomainAliases, failIfAliasNotLinked) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c;
     /**
      * Executes the command provided and stores it into a variable, so we can parse the output and extract metadata from it.
@@ -164,7 +171,7 @@ const deploy = (command, deployAlias, failIfAliasNotLinked) => __awaiter(void 0,
         core.debug(`VERCEL_DEPLOYMENT_DOMAIN=${deploymentDomain}`);
         core.exportVariable('VERCEL_DEPLOYMENT_DOMAIN', deploymentDomain);
         core.setOutput('VERCEL_DEPLOYMENT_DOMAIN', deploymentDomain);
-        if (deployAlias) {
+        if (applyDomainAliases) {
             yield createAliases(deploymentUrl, customDeploymentFile, failIfAliasNotLinked);
         }
     }

src/types.ts

@@ -33,6 +33,7 @@ export type VercelAliasResponse = {
   uid?: string;
   alias?: string;
   created?: string;
+  oldDeploymentId?: string;
 }
 
 /**
@@ -48,4 +49,4 @@ export type GenericObject<T = unknown> = Record<string, T>;
 export type ExecCommandOutput = {
   stdout: string;
   stderr: string;
-}
+}

src/vercel.ts

@@ -93,8 +93,10 @@ const createAliases = async (deploymentUrl: string, customDeploymentFile: string
 
       const aliasesResponse: VercelAliasResponse[] = await Promise.all<VercelAliasResponse>(aliasCreationPromises);
       core.debug(`Alias creation response: ${JSON.stringify(aliasesResponse)}`);
+      const aliasesErrors = aliasesResponse.filter((response: VercelAliasResponse) => response.error);
+      const aliasesSucceeded = aliasesResponse.filter((response: VercelAliasResponse) => !response.error);
 
-      if (aliasesResponse.filter((response) => response.error).length > 0) {
+      if (aliasesErrors.length > 0) {
         const failedAliases: (VercelAliasResponseError | undefined)[] = aliasesResponse.filter((response: VercelAliasResponse) => response.error).map((response) => response.error);
         const message = `Got following errors: ${JSON.stringify(failedAliases)}`;
 
@@ -103,9 +105,18 @@ const createAliases = async (deploymentUrl: string, customDeploymentFile: string
         core.setOutput('VERCEL_ALIASES_ERROR', failedAliases);
       }
 
-      for (const alias of aliasesResponse.filter((response) => !response.error)) {
-        core.debug(`Created alias ${alias}`);
+      for (const aliasSuccess of aliasesSucceeded) {
+        core.debug(`Created alias "${aliasSuccess?.alias}".`);
       }
+
+      const aliasesUrlsMarkdown: string = aliasesSucceeded.map((aliasSuccess) => `[${aliasSuccess?.alias}](https://${aliasSuccess?.alias})`).join(', ');
+
+      core.setOutput('VERCEL_ALIASES_CREATED', aliasesSucceeded);
+      core.exportVariable('VERCEL_ALIASES_CREATED', aliasesSucceeded.map((aliasSuccess) => aliasSuccess?.alias).join(', '));
+
+      core.setOutput('VERCEL_ALIASES_CREATED_URLS_MD', aliasesUrlsMarkdown);
+      core.exportVariable('VERCEL_ALIASES_CREATED_URLS_MD', aliasesUrlsMarkdown);
+
     } else {
       core.warning(`No "alias" key found in ${vercelConfigFile}`);
     }
@@ -114,7 +125,7 @@ const createAliases = async (deploymentUrl: string, customDeploymentFile: string
   }
 };
 
-const deploy = async (command: string, deployAlias: boolean, failIfAliasNotLinked: boolean): Promise<void> => {
+const deploy = async (command: string, applyDomainAliases: boolean, failIfAliasNotLinked: boolean): Promise<void> => {
   /**
    * Executes the command provided and stores it into a variable, so we can parse the output and extract metadata from it.
    *
@@ -166,7 +177,7 @@ const deploy = async (command: string, deployAlias: boolean, failIfAliasNotLinke
     core.exportVariable('VERCEL_DEPLOYMENT_DOMAIN', deploymentDomain);
     core.setOutput('VERCEL_DEPLOYMENT_DOMAIN', deploymentDomain);
 
-    if (deployAlias) {
+    if (applyDomainAliases) {
       await createAliases(deploymentUrl, customDeploymentFile, failIfAliasNotLinked);
     }
   } else {