Releasing and updating deps.

Author: manchicken

CHANGELOG.md

@@ -5,4 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
-## [Unreleased]
+## [1.0.0] - 2023-11-13
+
+### Added
+
+- Everything, really. This is the initial version, and it works.
+
+### To do
+
+- Tests. Lots of tests.

README.md

@@ -2,6 +2,33 @@
 
 This action deploys a project to Arc XP using your Arc XP credentials.
 
+## Description
+
+**NOTE:** This action requires that you have an active Arc XP account. If you do not have an Arc XP account, or you have any questions, please contact your Arc XP representative.
+
+This action deploys a Fusion Bundle to Arc XP using your Arc XP credentials. It will deploy the project to the Arc XP instance that matches the `api-hostname` input. If the project has not been deployed before, it will create an initial deployment. If the project has been deployed before, it will create a new deployment and delete the oldest deployment if the number of deployments exceeds the `minimum-running-versions` input.
+
+## Prerequisites
+
+You must have a Fusion Bundle that has been built and is ready to be deployed. You must also have an Arc XP organization ID, API key, and API hostname.
+
+## Security
+
+This action requires that you have an Arc XP account. It will use your Arc XP API key to authenticate with Arc XP. The API key is stored as a secret in your GitHub repository. The API key is used to authenticate with Arc XP and is not shared with anyone else.
+
+## Usage
+
+```yaml
+      - name: Perform the deploy
+        if: ${{ success() }}
+        uses: arcxp/deploy-action@v1
+        with:
+          org-id: your-org-here
+          api-key: "${{ secrets.YOUR_DEPLOYER_TOKEN_HERE }}"
+          api-hostname: api.sandbox.your-org-here.arcpublishing.com
+          bundle-prefix: action-demo-1
+```
+
 ## Inputs
 
 ### `org-id`
@@ -33,3 +60,63 @@ The number of seconds to wait between retries. Default `5`.
 The minimum number of versions to keep in a "deployed" state at any given time. The maximum is 10, the minimum is 1. Default `7`.
 
 ## Example
+
+Here's a complete example from a GitHub Action workflow file. This example first builds and zips the Fusion Bundle, and then uses this custom action to deploy to the "Sandbox" environment in the `arctesting2` instance of Arc XP.
+
+```yaml
+---
+name: Deploy a Fusion Bundle with Custom Action
+
+on:
+  push:
+    # Adjust this list of branches if you want to use this action
+    # for PRs and pushes.
+    branches:
+      - branch-name-here
+  # This action lets you run this Action manually.
+  workflow_dispatch:
+
+jobs:
+  new-deployer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        if: ${{ success() }}
+        uses: actions/checkout@v3
+
+      # This configures NodeJS for our purposes.
+      - name: Set up Node
+        if: ${{ success() }}
+        uses: actions/setup-node@v3
+        with:
+          #### IF YOU NEED TO CHANGE YOUR NODE VERSION, JUST CHANGE THIS NUMBER
+          node-version: 20
+          cache: npm
+
+      # Installs NodeJS dependencies.
+      - name: Install dependencies
+        if: ${{ success() }}
+        run: |
+          npm install
+
+      # Build the code.
+      - name: Build the Fusion Bundle
+        if: ${{ success() }}
+        run: |
+          npm run build
+          npm run zip
+
+      - name: Perform the deploy
+        if: ${{ success() }}
+        uses: arcxp/deploy-action@v1
+        with:
+          org-id: your-org-here
+          api-key: "${{ secrets.SANDBOX_DEPLOYER_TOKEN }}"
+          api-hostname: api.sandbox.your-org-here.arcpublishing.com
+          bundle-prefix: bundle-prefix-here
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

action.yml

@@ -3,8 +3,8 @@ name: 'Deploy to Arc XP'
 description: 'This is an action which makes it convenient to deploy to Arc XP'
 author: 'Arc XP'
 branding:
-  icon: 'monitor'
-  color: 'purple'
+  icon: 'truck'
+  color: 'blue'
 runs:
   using: node20
   main: dist/index.cjs

dist/index.cjs

@@ -21967,7 +21967,7 @@ var require_validation = __commonJS({
         return core2.setFailed(`Could not find artifact \xAB${artifact}\xBB`);
       }
     };
-    var verifyArcHost2 = ({ core: core2, apiHostname }) => apiHostname.match(/^[a-z0-9_.-]+?\.arcpublishing\.(net|com)$/i) ? true : core2.setFailed(`Host name '${apiHostname}' is not valid.`) && process2.exit(-1);
+    var verifyArcHost2 = ({ core: core2, apiHostname }) => apiHostname.match(/^[a-z0-9_.-]+?\.arcpublishing\.(com)$/i) ? true : core2.setFailed(`Host name '${apiHostname}' is not valid.`) && process2.exit(-1);
     var verifyMinimumRunningVersions2 = ({ core: core2, minimumRunningVersions }) => minimumRunningVersions >= 1 && minimumRunningVersions <= 10 ? true : core2.setFailed(
       `Minimum running versions '${minimumRunningVersions}' is not valid. Must be between 1 and 10.`
     );

package-lock.json

@@ -27,16 +27,16 @@
   "homepage": "https://github.com/arcxp/deploy-action#readme",
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.7",
-    "@types/node": "^20.8.10",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.9.0",
     "esbuild": "^0.19.5",
     "eslint": "^8.53.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-n": "^16.2.0",
+    "eslint-plugin-n": "^16.3.1",
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.7.0",
-    "prettier": "^3.0.3"
+    "prettier": "^3.1.0"
   },
   "dependencies": {
     "@actions/core": "^1.10.1",

package.json

@@ -14,7 +14,7 @@ const verifyArtifact = async ({ core, artifact }) => {
 }
 
 const verifyArcHost = ({ core, apiHostname }) =>
-  apiHostname.match(/^[a-z0-9_.-]+?\.arcpublishing\.(net|com)$/i)
+  apiHostname.match(/^[a-z0-9_.-]+?\.arcpublishing\.(com)$/i)
     ? true
     : core.setFailed(`Host name '${apiHostname}' is not valid.`) &&
       process.exit(-1)