(Major) Implement doc & refactoring workflow demonstration (#4)

Author: Demmonius

.github/workflows/check-build.yml

@@ -9,8 +9,7 @@ on:
   pull_request:
   push:
     branches:
-      - main
-      - 'releases/*'
+      - '*'
 
 jobs:
   run-build-test:

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

@@ -0,0 +1,23 @@
+name: 'GitHub Action deploy example'
+on:
+  pull_request:
+  push:
+    branches:
+      - '*'
+
+jobs:
+  run-example-deployment:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+#        with:
+#          path: "github-action-deploy-on-vercel" # Act doesn't work if not specifying the path. See https://github.com/nektos/act/issues/228
+      - uses: ./
+        with:
+          command: "yarn deploy:example --token ${{ secrets.VERCEL_TOKEN }}"
+          applyDomainAliases: true
+          failIfAliasNotLinked: false
+        env:
+          VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+
+      - run: "echo \"Found deployment url: ${{ env.VERCEL_DEPLOYMENT_URL }}\""

.github/workflows/run-integration-test.yml

@@ -1,17 +1,9 @@
-# Summary:
-# Test the GitHub Action using an integration test.
-# Makes sure the GitHub Action works properly when running on a clean machine, without building anything (integration test).
-# This integration test will break if the Vercel project or deployment are deleted, or if the VERCEl_TOKEN doesn't have access to the deployment url.
-#
-# See https://github.com/actions/checkout https://github.com/actions/checkout/releases/tag/v2
-
 name: 'GitHub Action integration test'
 on:
   pull_request:
   push:
     branches:
-      - main
-      - 'releases/*'
+      - '*'
 
 jobs:
   run-integration-test:
@@ -20,14 +12,11 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ./
         with:
-          command: "echo 'yarn vercel:cleanup && yarn vercel:deploy --local-config=vercel.customer1.staging.json and found https://app.vercel.app'"
+          command: "yarn test:integration"
+          applyDomainAliases: true
+          failIfAliasNotLinked: false
         env:
-          VERCEL_TOKEN: "temporary nothing"
-      - uses: ./
-        with:
-          command: ls
-      - uses: ./
-        with:
-          command: echo "test"
-        env:
-          VERCEL_TOKEN: "temporary nothing"
+          VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+          VERCEL_DEPLOYMENT_URL: "https://github-action-deploy-on-vercel-example.vercel.app/"
+
+      - run: "echo \"Found deployment url: ${{ env.VERCEL_DEPLOYMENT_URL }}\""

.gitignore

@@ -127,3 +127,5 @@ yarn-error.log*
 
 # Tmp files (cache, etc.)
 *.cache
+
+.vercel

.idea/.gitignore

@@ -1,10 +1,10 @@
 <a href="https://unly.org"><img src="https://storage.googleapis.com/unly/images/ICON_UNLY.png" align="right" height="20" alt="Unly logo" title="Unly logo" /></a>
-[![Maintainability](https://api.codeclimate.com/v1/badges/9e073b5db2eec4c4e5c8/maintainability)](https://codeclimate.com/github/UnlyEd/github-action-store-variable/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/9e073b5db2eec4c4e5c8/test_coverage)](https://codeclimate.com/github/UnlyEd/github-action-store-variable/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/97a6022a22be785dd2ea/maintainability)](https://codeclimate.com/github/UnlyEd/github-action-deploy-on-vercel/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/97a6022a22be785dd2ea/test_coverage)](https://codeclimate.com/github/UnlyEd/github-action-deploy-on-vercel/test_coverage)
 
-![GitHub Action integration test](https://github.com/UnlyEd/github-action-store-variable/workflows/GitHub%20Action%20integration%20test/badge.svg)
-![GitHub Action build test](https://github.com/UnlyEd/github-action-store-variable/workflows/GitHub%20Action%20build%20test/badge.svg)
-![Update Code Climate test coverage](https://github.com/UnlyEd/github-action-store-variable/workflows/Update%20Code%20Climate%20test%20coverage/badge.svg)
+![GitHub Action integration test](https://github.com/UnlyEd/github-action-deploy-on-vercel/workflows/GitHub%20Action%20integration%20test/badge.svg)
+![GitHub Action build test](https://github.com/UnlyEd/github-action-deploy-on-vercel/workflows/GitHub%20Action%20build%20test/badge.svg)
+![Update Code Climate test coverage](https://github.com/UnlyEd/github-action-deploy-on-vercel/workflows/Update%20Code%20Climate%20test%20coverage/badge.svg)
 
 # GitHub Action - Store variables between your jobs
 
@@ -13,182 +13,62 @@
 ```yaml
 name: 'GitHub Action code snippet'
 on:
+  pull_request:
   push:
     branches:
       - '*'
+
 jobs:
-  # On some job, do some stuff an persist variables meant to be re-used in other jobs
-  compute-data:
-    name: Compute data
+  run-example-deployment:
     runs-on: ubuntu-18.04
     steps:
-      # Do your own internal business logic...
-      - name: Compute ressource
-        run: |
-          MAGIC_NUMBER=42
-          echo "Found universal answer: $MAGIC_NUMBER"
-          echo "Exporting it as ENV variable..."
-          echo "MAGIC_NUMBER=$MAGIC_NUMBER" >> $GITHUB_ENV
-
-      # XXX We recommend to export all your variables at once, at the end of your job
-      - name: Export variable for next jobs
-        uses: UnlyEd/github-action-store-variable@v2.1.0 # See https://github.com/UnlyEd/github-action-store-variable
+      - uses: actions/checkout@v2
+      - uses: UnlyEd/github-action-deploy-on-vercel@latest
         with:
-          # Persist (store) our MAGIC_NUMBER ENV variable into our store, for the next jobs
-          variables: |
-            MAGIC_NUMBER=${{ env.MAGIC_NUMBER }}
+          command: "vercel examples/static-deployment --confirm --debug --token ${{ secrets.VERCEL_TOKEN }}"
+        env:
+          VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
 
-  # In another job, read the previously stored variable and use it
-  retrieve-data:
-    name: Find & re-use data
-    runs-on: ubuntu-18.04
-    needs: compute-data
-    steps:
-      - name: Import variable MAGIC_NUMBER
-        uses: UnlyEd/github-action-store-variable@v2.1.0 # See https://github.com/UnlyEd/github-action-store-variable
-        with:
-          # List all variables you want to retrieve from the store
-          # XXX They'll be automatically added to your ENV
-          variables: | 
-            MAGIC_NUMBER
-      - name: Debug output
-        run: echo "We have access to $MAGIC_NUMBER"
+      - run: "echo \"Found deployment url: ${{ env.VERCEL_DEPLOYMENT_URL }}\""
 ```
 
-> If you want to see a real output, check out the output of our code snippet example [here](https://github.com/UnlyEd/github-action-store-variable/actions/runs/537556204).
-
-See the [Examples section](#examples) for more advanced examples.
-
 ## What does this GitHub Action do?
 
-You can use this action to **store variables** in a sort of "global store" for your GitHub Actions.
+You can use this action to deploy a Vercel project online through a GitHub action.
 
-Then, you can **read the variables** that have been stored previously.
+The action will return the url of the Vercel deployment _(and store it as environment variable, too)_, it will also apply domain aliases if there are any configured in the Vercel config file (`vercel.config` by default).
 
-The variables stored can be read by any job within the same workflow.
-
-> **N.B**: When you read a variable, **it is automatically added as an ENV variable** and will erase any variable with the same name.
-> 
-> This behavior helps keeping the code cleaner by only manipulating (reading/writing) ENV variables.
-> In v1, we had to read the variables from a JSON object, and [it was ugly](https://github.com/UnlyEd/github-action-store-variable/blob/c4143c0d7f/.github/workflows/run-integration-test.yml#L29).
-
-> N.B: You can both **read and write** in the same action.
+> It works quite differently compared to [`vercel-action`](https://github.com/marketplace/actions/vercel-action).
 
 ## Why/when should you use it?
 
-GitHub Actions doesn't allow to natively re-use variables between jobs.
-
-If you need to **re-use variables defined in a job in other** (subsequent) jobs, then you can use this action.
+You want to run a custom command that (amongst other things) performs a Vercel deployment.
 
 ### Action's API
 
 #### Inputs
 
 Name | Required | Default | Description
 ---  | --- |--- |---
-`variables`|✅| | Write variable: `VAR=VALUE` - Read variable: `VAR`
-`delimiter`|✖️|`\r?\n`| Regex delimiter between each variable, defaults to normal line break
-`failIfNotFound`|✖️|`false`| If true, will throw an error (and crash CI) when attempting to read a variable that doesn't exist in the store
+`command`|✅| | Command starting the vercel deployment
+`applyDomainAliases`|✖️|`true`| If true, will create Vercel aliases using the aliases specified in the vercel config file
+`failIfAliasNotLinked`|✖️|`false`| If true, will throw an error (and crash CI) when there is an error about aliases link
 
 #### Outputs
 
-There are no outputs for this action, reading variables **automatically** adds these variables in `${{ env }}`.
-
-For example, if you read a variable named `VAR`, you can then access it by using `${{ env.VAR }}`.
-
-## Examples
+The below variables are available as outputs, but are also **injected as environment variables automatically**.
 
-### 1. Save one variable
-
-```yaml
-- name: Export one variable
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    variables: FOO=BAR
-```
-
-### 2. Save many variables
-
-```yaml
-- name: Export many variables
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    variables: |
-      FOO=BAR
-      STAGE=production
-```
-
-> Pro-tip: We recommend always using the `variables: |` syntax (multi lines), because it's just simpler to add more variables later on.
-
-### 3. Save one variable and read another
-
-```yaml
-- name: Export one variable
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    # Writes "FOO" and reads "STAGE"
-    variables: |
-      FOO=BAR
-      STAGE
-```
-
-### 4. Save many variables using a custom delimiter
-
-```yaml
-- name: Export many variables
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    delimiter: ':'
-    variables: FOO=BAR:STAGE=production
-```
-
-### 5. Retrieve one variable
-
-```yaml
-- name: Import variable MAGIC_NUMBER
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    variables: FOO
-```
-
-### 6. Retrieve many variables
-
-```yaml
-- name: Import variable MAGIC_NUMBER
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    variables: |
-      FOO
-      STAGE
-```
-
-### 7. Retrieve many variables using a custom delimiter
-
-```yaml
-- name: Import variable MAGIC_NUMBER
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    delimiter: ';'
-    variables: FOO;STAGE
-```
-
-### 8. Crash CI if variable doesn't exist
-
-```yaml
-- name: Import variable MAGIC_NUMBER
-  uses: UnlyEd/github-action-store-variable@v2.1.0
-  with:
-    failIfNotFound: true
-    variables: WRONG_VARIABLE
-```
+- `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
 
-> N.B: If you want to crash only for some variables, then you can call 2 times the `UnlyEd/github-action-store-variable` and have `failIfNotFound: true` in one of them.
+> 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:
 
 Here are a few community-powered examples, those are usually advanced use-cases!
 
-- [Next Right Now](https://github.com/UnlyEd/next-right-now/blob/60455642a5c5248c3e0e9604de080e24ef9eed0a/.github/workflows/deploy-vercel-staging.yml#L250-L260) _(Disclosure: We're the author!)_
+- [Next Right Now](https://github.com/UnlyEd/next-right-now) _(Disclosure: We're the author!)_
 
 ---
 

.idea/jsLibraryMappings.xml

@@ -1,23 +1,27 @@
 name: 'Deploy on Vercel'
 description: 'Easily deploy your project on Vercel'
 branding:
-#icon: bookmark #TODO
-#color: red
+  icon: box
+  color: gray-dark
 inputs:
   command:
-    description: 'Command to execute to start vercel deployment'
+    description: 'Command starting the vercel deployment'
     required: true
-  apply_domain_aliases:
-    description: 'Enable alias feature in the vercel.json'
+  applyDomainAliases:
+    description: 'If true, will create Vercel aliases using the aliases specified in the vercel config file'
     required: false
     default: "true"
   failIfAliasNotLinked:
     description: 'If true, will throw an error (and crash CI) when there is an error about aliases link'
     required: false
     default: "false"
 outputs:
-  deployment-url:
-    description: "Url deployed"
+  VERCEL_DEPLOYMENT_URL:
+    description: "Full Vercel deployment url (parsed from the deployment logs), e.g: https://xxx.vercel.app"
+  VERCEL_DEPLOYMENT_DOMAIN:
+    description: "Url without the protocol declaration, e.g: xxx.vercel.app"
+  VERCEL_ALIASES_ERROR:
+    description: "(optional) Vercel errors during domain aliasing"
 runs:
   using: 'node12'
   main: 'lib/main.js'

README.md

@@ -0,0 +1 @@
+.vercel

action.yml

@@ -0,0 +1,3 @@
+<html>
+    <h1>Deployment succeeded, deployed by <code>run-example-deployment</code> GitHub workflow.</h1>
+</html>

examples/static-deployment/.gitignore

@@ -0,0 +1,9 @@
+{
+  "version": 2,
+  "name": "github-action-deploy-on-vercel-example",
+  "scope": "team_qnVfSEVc2WwmOE1OYhZr4VST",
+  "alias": [
+    "github-action-deploy-on-vercel-example-alias.vercel.app",
+    "deploy-on-vercel-example.vercel.app"
+  ]
+}

examples/static-deployment/index.html

@@ -99,10 +99,12 @@ const create_aliases = (deploymentUrl, customDeploymentFile, failIfAliasNotLinke
             core.debug(`Resolving alias promises`);
             const aliasesResponse = yield Promise.all(aliasCreationPromises);
             console.log(`Alias creation response: ${JSON.stringify(aliasesResponse)}`);
-            if (aliasesResponse.filter(response => response.error)) {
+            if (aliasesResponse.filter(response => response.error).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);
+                console.log(`Exporting this error...`);
+                core.setOutput('VERCEL_ALIASES_ERROR', failedAliases);
             }
             for (const alias of aliasesResponse.filter(response => !response.error)) {
                 console.log(`Created alias ${alias}`);
@@ -118,6 +120,10 @@ const create_aliases = (deploymentUrl, customDeploymentFile, failIfAliasNotLinke
 });
 const deploy = (command, deployAlias, failIfAliasNotLinked) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c;
+    /**
+     * Execute the command provided and store it into a variable
+     * exec_command also displays the output
+     */
     const stdout = yield exec_command(command);
     /**
      * Parsing this huge output by using Regex match.