Add outputs to get the preview-url and preview-name (#23)

* feat: add outputs to get the preview-url and preview-name (#22)
* feat: add outputs to get the preview-url and preview-name
* chore: add dist/
* minor changes
* fix env variable in workflows
* update version

Author: South-Paw

.github/workflows/pull_request.yml

@@ -27,5 +27,5 @@ jobs:
           netlify-auth-token: ${{ secrets.NETLIFY_AUTH_TOKEN }}
           netlify-site-id: ${{ secrets.NETLIFY_SITE_ID }}
           build-dir: "./example"
-          github-env: "development"
+          github-deployment-environment: "development"
           draft: true

.github/workflows/push.yaml

@@ -55,7 +55,7 @@ jobs:
           build-dir: "./example"
           comment-on-pull-request: true
           comment-on-commit: true
-          github-env: "development"
+          github-deployment-environment: "development"
           draft: true
           dry-run: true
 
@@ -81,7 +81,7 @@ jobs:
           build-dir: "./example"
           comment-on-pull-request: true
           comment-on-commit: true
-          github-env: "test"
+          github-deployment-environment: "test"
           draft: true
 
   deployProduction:
@@ -105,4 +105,4 @@ jobs:
           netlify-site-id: ${{ secrets.NETLIFY_SITE_ID }}
           build-dir: "./example"
           comment-on-commit: true
-          github-env: "production"
+          github-deployment-environment: "production"

README.md

@@ -23,6 +23,16 @@ There are 4 required inputs for the action
 
 See the [action.yml](./action.yml) for other action inputs and their descriptions
 
+## Outputs
+
+### `preview-url`
+
+The url of deployment preview.
+
+### `preview-name`
+
+The name of deployment name.
+
 ## Usage
 
 Here are some ideas of how to configure this action in different workflows...

action.yml

@@ -66,3 +66,8 @@ inputs:
   message:
     description: "A short message to associate with the deploy (Note: setting this will override the default deploy message of `<type>: <title> [short_sha]`)"
     required: false
+outputs:
+  preview-url:
+    description: "deployment preview URL"
+  preview-name:
+    description: "deployment preview name"

dist/index.js

@@ -113,6 +113,8 @@ function run() {
                     const fnDir = functionsDir ? path.resolve(process.cwd(), functionsDir) : undefined;
                     const deployment = yield netlifyClient.deploy(siteId, siteDir, { configPath, draft, fnDir, message });
                     deploy = deployment.deploy;
+                    core.setOutput('preview-name', deploy.name);
+                    core.setOutput('preview-url', util_1.getDeployUrl(draft, deploy));
                 }
                 catch (error) {
                     process.stderr.write('netlifyClient.deploy() failed\n');

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@south-paw/action-netlify-deploy",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Netlify deployments via GitHub actions",
   "keywords": [],
   "homepage": "https://github.com/South-Paw/action-netlify-deploy",

package.json

@@ -84,6 +84,8 @@ async function run(): Promise<void> {
         const deployment = await netlifyClient.deploy(siteId, siteDir, { configPath, draft, fnDir, message });
 
         deploy = deployment.deploy;
+        core.setOutput('preview-name', deploy.name);
+        core.setOutput('preview-url', getDeployUrl(draft, deploy));
       } catch (error) {
         process.stderr.write('netlifyClient.deploy() failed\n');
         process.stderr.write(`${JSON.stringify(error, null, 2)}\n`);