docs(README.md): update documentation with new examples and clarify usage

Add a new "Merge to Main" example for GitHub Actions. Clarify the
working directory parameter and its common patterns. Improve
descriptions for manifest fields and common issues. Remove redundant
sections to streamline the document.

docs: add MIT license file

Add a LICENSE file with the MIT License to clarify the project's
licensing terms and ensure legal compliance.

style(dist/index.js): add trailing commas for consistency

Add trailing commas to module exports for consistency with code style
guidelines and improve readability.

chore(package.json): update description and author information

Update the package description to better reflect its purpose. Change
the author field to "Domo Developer Innovations" for accuracy.

Author: Jon Tiritilli

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Domo, Inc.
+
+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

@@ -6,7 +6,7 @@ A GitHub Action for deploying Domo apps from GitHub to a Domo instance using the
 
 - 🔐 **Token-based Authentication**: Secure authentication using Domo API tokens
 - 🔨 **Optional Build Step**: Run custom build commands before deployment
-- 📦 **Automatic ryuu Installation**: Installs the ryuu package globally (provides `domo` CLI) if not present
+- 📦 **Automatic Ryuu Installation**: Installs the ryuu package globally (provides `domo` CLI) if not present
 - ✅ **Comprehensive Error Handling**: Detailed error messages and status reporting
 - 🚀 **Easy Integration**: Simple setup with minimal configuration
 
@@ -34,6 +34,33 @@ jobs:
           domo-instance: https://your-company.domo.com
 ```
 
+### Merge to Main Example
+
+```yaml
+name: Deploy on Merge to Main
+on:
+  pull_request:
+    types: [closed]
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    # Only run when PR is actually merged (not just closed)
+    if: github.event.pull_request.merged == true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Deploy to Domo
+        uses: DomoApps/domoapps-publish-action@v1
+        with:
+          domo-token: ${{ secrets.DOMO_ACCESS_TOKEN }}
+          domo-instance: https://your-company.domo.com
+          build-command: npm run build
+          working-directory: ./build
+```
+
 ### With Build Command
 
 ```yaml
@@ -55,7 +82,7 @@ jobs:
           domo-token: ${{ secrets.DOMO_ACCESS_TOKEN }}
           domo-instance: https://your-company.domo.com
           build-command: npm run build
-          working-directory: ./my-domo-app
+          working-directory: ./dist
 ```
 
 ## Inputs
@@ -65,7 +92,7 @@ jobs:
 | `domo-token`        | Domo API token for authentication                         | ✅       | -       |
 | `domo-instance`     | Domo instance URL (e.g., `https://your-company.domo.com`) | ✅       | -       |
 | `build-command`     | Optional build command to run before deployment           | ❌       | -       |
-| `working-directory` | Working directory for the action                          | ❌       | `.`     |
+| `working-directory` | Build output directory containing the Domo app files      | ❌       | `.`     |
 
 ## Outputs
 
@@ -135,17 +162,14 @@ Here's the minimal manifest structure required for Domo app deployment:
 
 ### Manifest Field Descriptions
 
-| Field                 | Required | Description                                              |
-| --------------------- | -------- | -------------------------------------------------------- |
-| `name`                | ✅       | Display name of your app                                 |
-| `version`             | ✅       | Semantic version (e.g., "1.0.0")                         |
-| `size.width`          | ✅       | App width in pixels                                      |
-| `size.height`         | ✅       | App height in pixels                                     |
-| `id`                  | ✅       | Unique app identifier (UUID format)                      |
-| `mapping`             | ✅       | Array of dataset mappings                                |
-| `mapping[].dataSetId` | ✅       | Dataset ID to connect to your app                        |
-| `mapping[].alias`     | ✅       | Alias name for the dataset in your app                   |
-| `mapping[].fields`    | ❌       | Array of specific fields to include (empty = all fields) |
+| Field         | Required | Description                         |
+| ------------- | -------- | ----------------------------------- |
+| `name`        | ✅       | Display name of your app            |
+| `version`     | ✅       | Semantic version (e.g., "1.0.0")    |
+| `size.width`  | ✅       | App width in pixels                 |
+| `size.height` | ✅       | App height in pixels                |
+| `id`          | ✅       | Unique app identifier (UUID format) |
+| `mapping`     | ✅       | Array of dataset mappings           |
 
 ### Common Manifest Issues
 
@@ -166,16 +190,6 @@ The Design ID is automatically generated by Domo when you create an app. You can
 3. Look for "Design Id:" in the app details section
 4. Copy the UUID (e.g., `f46a7a19-9237-41f5-9850-ef453e181614`)
 
-#### Dataset ID
-
-Find your dataset ID in Domo:
-
-1. Go to your dataset in Domo
-2. Look at the URL: `https://your-company.domo.com/datasources/overview/{dataset-id}`
-3. Copy the dataset ID from the URL
-
-This will help catch common issues before deployment.
-
 ## Advanced Usage
 
 ### Multiple Environments
@@ -239,14 +253,25 @@ jobs:
         run: npm ci
 
       - name: Deploy to Domo
-        uses: DomoApps/domoapps-publish-action@v1
+        uses: DomoApps/domoapps-publish-action@latest
         with:
           domo-token: ${{ secrets.DOMO_ACCESS_TOKEN }}
           domo-instance: https://your-company.domo.com
           build-command: npm run build
-          working-directory: .
+          working-directory: ./build
 ```
 
+## Working Directory
+
+The `working-directory` parameter should point to the **build output directory** containing your compiled Domo app files (typically `./build`, `./dist`, or `./out`). This is where your build process outputs the final Domo app files that will be deployed.
+
+**Common patterns:**
+
+- `./build` - Most common build output directory
+- `./dist` - Alternative build output directory
+- `./out` - Another common build output directory
+- `.` - Only use if your app files are in the repository root, such as **ProCode apps**
+
 ## How It Works
 
 The action uses the `ryuu` npm package (which provides the `domo` CLI command) to deploy Domo apps. The authentication process follows these steps:
@@ -262,31 +287,25 @@ The action automatically handles the instance name extraction from the full Domo
 ### Common Issues
 
 1. **Authentication Failed**
-
    - Verify your Domo token is correct and has proper permissions
    - Check that the Domo instance URL is correct
 
-2. **Build Command Failed**
-
+1. **Build Command Failed**
    - Ensure the build command is valid for your environment
    - Check that all required dependencies are installed
 
-3. **Manifest Not Found**
+1. **Manifest Not Found**
    - Ensure the working directory contains a valid `manifest.json`
    - Verify the manifest has the correct `id` field for your Domo asset
 
+1. **Manifest Errors**
+   - Verify required fields are present
+   - Ensure there are no blank spaces (' ') in the field aliases
+
 ### Debug Mode
 
 To enable debug logging, set the `ACTIONS_STEP_DEBUG` secret to `true` in your repository settings.
 
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Add tests for new functionality
-5. Submit a pull request
-
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

dist/index.js

@@ -25658,7 +25658,7 @@ async function authenticateDomo(domoToken, domoInstance) {
 }
 
 module.exports = {
-  authenticateDomo
+  authenticateDomo,
 };
 
 
@@ -25681,7 +25681,7 @@ function changeDirectory(workingDirectory) {
 }
 
 module.exports = {
-  changeDirectory
+  changeDirectory,
 };
 
 
@@ -25702,7 +25702,7 @@ async function publishAppStep(appPath, domoInstance) {
 }
 
 module.exports = {
-  publishAppStep
+  publishAppStep,
 };
 
 
@@ -25734,7 +25734,7 @@ async function runBuild(buildCommand) {
 }
 
 module.exports = {
-  runBuild
+  runBuild,
 };
 
 
@@ -25743,7 +25743,10 @@ module.exports = {
 /***/ 4015:
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
-const { ensurePackageManager, installDependencies } = __nccwpck_require__(9260);
+const {
+  ensurePackageManager,
+  installDependencies,
+} = __nccwpck_require__(9260);
 const { ensureRyuuInstalled } = __nccwpck_require__(6313);
 
 /**
@@ -25761,7 +25764,7 @@ async function setupEnvironment() {
 }
 
 module.exports = {
-  setupEnvironment
+  setupEnvironment,
 };
 
 
@@ -25794,7 +25797,7 @@ function validateInputs(domoToken, domoInstance) {
 }
 
 module.exports = {
-  validateInputs
+  validateInputs,
 };
 
 
@@ -25812,9 +25815,7 @@ const core = __nccwpck_require__(7484);
  * @returns {string} The instance name
  */
 function extractInstanceName(domoInstance) {
-  return domoInstance
-    .replace(/^https?:\/\//, '')
-    .replace(/\/$/, '');
+  return domoInstance.replace(/^https?:\/\//, '').replace(/\/$/, '');
 }
 
 /**
@@ -25839,9 +25840,9 @@ async function ensureRyuuInstalled() {
  */
 async function authenticateWithDomo(domoToken, domoInstance) {
   core.info('🔐 Adding Domo token and authenticating...');
-  
+
   const instanceName = extractInstanceName(domoInstance);
-  
+
   // Add token to domo CLI
   const addTokenCommand = `domo token -i ${instanceName} -t ${domoToken} add`;
   await exec.exec('bash', ['-c', addTokenCommand]);
@@ -25860,11 +25861,11 @@ async function authenticateWithDomo(domoToken, domoInstance) {
  */
 async function publishApp(appPath, domoInstance) {
   core.info('📤 Publishing app to Domo...');
-  
+
   const publishCommand = `domo publish "${appPath}"`;
   await exec.exec('bash', ['-c', publishCommand]);
   core.info('✅ App published successfully');
-  
+
   // Set outputs
   core.setOutput('deployment-status', 'success');
   core.setOutput('app-url', `${domoInstance}/app/${appPath}`);
@@ -25874,7 +25875,7 @@ module.exports = {
   extractInstanceName,
   ensureRyuuInstalled,
   authenticateWithDomo,
-  publishApp
+  publishApp,
 };
 
 
@@ -25908,7 +25909,7 @@ function detectPackageManager() {
 async function ensurePackageManager() {
   try {
     const packageManager = detectPackageManager();
-    
+
     if (packageManager === 'pnpm') {
       core.info('📦 Detected pnpm lock file, ensuring pnpm is available...');
       try {
@@ -25932,7 +25933,7 @@ async function ensurePackageManager() {
     } else {
       core.info('📦 Using npm (default package manager)');
     }
-    
+
     return packageManager;
   } catch (error) {
     core.warning(`⚠️ Could not detect package manager: ${error.message}`);
@@ -25959,7 +25960,7 @@ async function installDependencies() {
 
     const packageManager = detectPackageManager();
     core.info('📦 Installing dependencies...');
-    
+
     if (packageManager === 'pnpm') {
       await exec.exec('pnpm', ['install', '--frozen-lockfile']);
     } else if (packageManager === 'yarn') {
@@ -25971,7 +25972,7 @@ async function installDependencies() {
         await exec.exec('npm', ['install']);
       }
     }
-    
+
     core.info('✅ Dependencies installed successfully');
   } catch (error) {
     core.warning(`⚠️ Could not install dependencies: ${error.message}`);
@@ -25981,7 +25982,7 @@ async function installDependencies() {
 module.exports = {
   detectPackageManager,
   ensurePackageManager,
-  installDependencies
+  installDependencies,
 };
 
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "domo-publish-action",
   "version": "1.0.0",
-  "description": "GitHub Action for deploying Domo apps using domo CLI",
+  "description": "GitHub Action for deploying Domo apps to Domo instances",
   "main": "dist/index.js",
   "scripts": {
     "build": "ncc build src/index.js -o dist",
@@ -16,7 +16,7 @@
     "deployment",
     "domo-cli"
   ],
-  "author": "Your Name",
+  "author": "Domo Developer Innovations",
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.10.0",