feat: initial release

.eslintignore

@@ -0,0 +1,2 @@
+dist/
+coverage/

.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "globals": {
+    "jest": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "plugin:jest/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  }
+}

.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'monthly'
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: 'monthly'

.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  test:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm ci
+      - run: npm test
+      - run: npx semantic-release

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - '**'
+      - '!main'
+
+jobs:
+  test:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - run: npm ci
+      - name: Lint Code Base
+        uses: github/[email protected]
+        env:
+          LINTER_RULES_PATH: /
+          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
+          VALIDATE_ALL_CODEBASE: true
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          DEFAULT_BRANCH: main
+      - run: npm test

.gitignore

@@ -0,0 +1,37 @@
+node_modules/
+
+# Editors
+.vscode/
+.idea/
+*.iml
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "none"
+}

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# How to contribute
+
+We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+
+## Code reviews
+
+All submissions require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
+
+## Style Guide
+
+This project provides a prettier configuration. All submitted PRs will be required to conform to this style guide before being merged.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Zentered OÜ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,73 @@
+# Cloudflare Preview URL
+
+![Test](https://github.com/zentered/cloudflare-preview-url/workflows/Test/badge.svg)
+![Release](https://github.com/zentered/cloudflare-preview-url/workflows/Publish/badge.svg)
+![Semantic Release](https://github.com/govolition/storefront-api/workflows/Semantic%20Release/badge.svg)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+
+Retrieve the preview URL from the Cloudflare API, filtered by the repo and branch. The URL can then be used for further end-to-end tests, link checks and other PR integrations/actions.
+
+## Table of Contents
+
+- [Usage](#usage)
+- [Environment Variables](#environment-variables--secret)
+- [Inputs](#inputs)
+- [Outputs](#outputs)
+
+## Usage
+
+[Copy your "Global API Key"](https://dash.cloudflare.com/profile/api-tokens)
+
+Cloudflare needs a little time to build the preview, you can check the average build time in your deployments and add the seconds plus a little to a `sleep` action, to wait until the deployment is ready. The action only works on branches, so make sure you exclude the `main` branch from the trigger:
+
+```yaml
+on:
+  push:
+    branches:
+      - '**'
+      - '!main'
+```
+
+Here are the steps for an example job:
+
+```yaml
+- run: sleep 30
+- name: cloudflare-preview-url
+  uses: zentered/[email protected]
+  id: cloudflare_preview_url
+  env:
+    CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+    CLOUDFLARE_ACCOUNT_EMAIL: ${{ secrets.CLOUDFLARE_ACCOUNT_EMAIL }}
+    CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+  with:
+    cloudflare_project_id: 'repo-name'
+- name: Get URL
+  run: echo "https://${{ steps.cloudflare_preview_url.outputs.preview_url }}"
+```
+
+## Environment Variables / Secret
+
+In the repository, go to "Settings", then "Secrets" and add "CLOUDFLARE_API_TOKEN", the value you can retrieve on your [Cloudflare account](https://dash.cloudflare.com/profile/api-tokens). You also need to add:
+
+- `CLOUDFLARE_ACCOUNT_EMAIL` (your login email)
+- `CLOUDFLARE_ACCOUNT_ID` (from the URL: `https://dash.cloudflare.com/123abc....`)
+
+## Inputs
+
+| Name                    | Requirement | Description                |
+| ----------------------- | ----------- | -------------------------- |
+| `cloudflare_project_id` | required    | Cloudflare project id/name |
+
+## Outputs
+
+| Name          | Description                                                                                                             |
+| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `preview_url` | A string with the unique URL of the deployment. If it hasn't finished uploading (is incomplete), the value will be null |
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+See [LICENSE](LICENSE).

action.yml

@@ -0,0 +1,15 @@
+branding:
+  color: orange
+  icon: triangle
+description: 'Receive the deployment preview URL from Cloudflare'
+inputs:
+  cloudflare_project_id:
+    description: 'Cloudflare project id / name'
+    required: true
+name: Cloudflare Preview URL
+outputs:
+  preview_url:
+    description: "A string with the unique URL of the deployment. If it hasn't finished uploading (is incomplete), the value will be null."
+runs:
+  main: dist/index.js
+  using: node12

babel.config.json

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": true
+        }
+      }
+    ]
+  ]
+}

cloudflare.mjs

@@ -0,0 +1,50 @@
+import core from '@actions/core'
+import axios from 'axios'
+
+export default async function getDeploymentUrl(
+  token,
+  accountId,
+  accountEmail,
+  projectId,
+  repo,
+  branch
+) {
+  const apiUrl = `https://api.cloudflare.com/client/v4/accounts/${accountId}/pages/projects/${projectId}/deployments`
+
+  core.info(`Fetching from: ${apiUrl}`)
+
+  const { data } = await axios.get(apiUrl, {
+    headers: {
+      'X-Auth-Key': token,
+      'X-Auth-Email': accountEmail
+    },
+    responseType: 'json',
+    responseEncoding: 'utf8'
+  })
+
+  if (!data || !data.result || data.result.length <= 0) {
+    core.error(JSON.stringify(data))
+    throw new Error('no deployments found')
+  }
+
+  core.info(`Found ${data.result.length} deployments`)
+  core.debug(`Looking for matching deployments ${repo}/${branch}`)
+  const builds = data.result
+    .filter((d) => d.environment === 'preview')
+    .filter((d) => d.source.config.repo_name === repo)
+    .filter((d) => d.deployment_trigger.metadata.branch === branch)
+
+  core.info(`Found ${builds.length} matching builds`)
+  if (!builds || builds.length <= 0) {
+    core.error(JSON.stringify(builds))
+    throw new Error('no matching builds found')
+  }
+
+  const build = builds[0]
+  core.info(
+    `Preview URL: https://${build.url} (${build.latest_stage.name} - ${build.latest_stage.status})`
+  )
+  return {
+    url: build.url
+  }
+}