help-commands

Author: justin808

.github/workflows/help-command.yml

@@ -1,4 +1,4 @@
-name: Show Help for Commands
+name: Show Detailed Help
 
 on:
   issue_comment:
@@ -27,9 +27,13 @@ jobs:
         with:
           script: |
             try {
-              console.log('Creating help message...');
+              console.log('Creating detailed help message...');
               const helpMessage = [
-                '## 📚 Available Commands',
+                '# 📚 Detailed Review App Commands Guide',
+                '',
+                'This is a detailed guide to using review app commands. For a quick reference, see the message posted when your PR was created.',
+                '',
+                '## Available Commands',
                 '',
                 '### `/deploy-review-app`',
                 'Deploys your PR branch to a review environment on Control Plane.',
@@ -59,16 +63,30 @@ jobs:
                 '- `CPLN_ORG`: Control Plane organization name',
                 '',
                 '### `/help`',
-                'Shows this help message explaining available commands and configuration.',
+                'Shows this detailed help message.',
                 '',
                 '---',
-                '**Note:** These commands only work in pull request comments.',
+                '## Environment Setup',
                 '',
-                '**Environment Setup:**',
                 '1. Set required secrets in your repository settings:',
                 '   - `CPLN_TOKEN`',
                 '   - `CPLN_ORG`',
-                '2. Optional: Configure `WAIT_TIMEOUT` in GitHub Actions variables to customize deployment timeout'
+                '',
+                '2. Optional: Configure `WAIT_TIMEOUT` in GitHub Actions variables to customize deployment timeout',
+                '',
+                '## Control Plane Integration',
+                '',
+                'Review apps are deployed to Control Plane with the following configuration:',
+                '- App Name Format: `qa-react-webpack-rails-tutorial-pr-{PR_NUMBER}`',
+                '- Console URL: `https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info`',
+                '',
+                '## Automatic Cleanup',
+                '',
+                'Review apps are automatically deleted when:',
+                '- The PR is closed (merged or not merged)',
+                '- The PR is stale (via nightly cleanup job)',
+                '',
+                'For more information, see the [React on Rails Tutorial documentation](https://github.com/shakacode/react-on-rails/tree/master/react-webpack-rails-tutorial)'
               ].join('\n');
               
               console.log('Issue number:', github.context.payload.issue.number);

.github/workflows/review-app-help.yml

@@ -1,42 +1,52 @@
-name: Review App Help
+name: Show Quick Help on PR Creation
 
 on:
   pull_request:
     types: [opened]
-  issue_comment:
-    types: [created]
 
 permissions:
-  pull-requests: write
   issues: write
+  pull-requests: write
 
 jobs:
-  Post-Help-Message:
-    if: |
-      (github.event_name == 'pull_request') ||
-      (github.event_name == 'issue_comment' && 
-       github.event.issue.pull_request && 
-       github.event.comment.body == '/show-help')
+  show-quick-help:
+    if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
 
     steps:
-      - name: Post Help Message
+      - name: Show Quick Reference
         uses: actions/github-script@v7
         with:
           script: |
-            const helpMessage = [
-              '## Review App Commands',
-              '',
-              '- `/deploy-review-app` - Deploy a review app for this PR',
-              '- `/delete-review-app` - Delete the review app for this PR',
-              '- `/show-help` - Show this help message',
-              '',
-              'The review app will be automatically deleted when the PR is closed or merged.'
-            ].join('\n');
-            
-            await github.rest.issues.createComment({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.issue.number || context.payload.pull_request.number,
-              body: helpMessage
-            });
+            try {
+              console.log('Creating quick reference message...');
+              const helpMessage = [
+                '# 🚀 Quick Review App Commands',
+                '',
+                'Welcome! Here are the commands you can use in this PR:',
+                '',
+                '### `/deploy-review-app`',
+                'Deploy your PR branch for testing',
+                '',
+                '### `/delete-review-app`',
+                'Remove the review app when done',
+                '',
+                '### `/help`',
+                'Show detailed documentation',
+                '',
+                '---',
+                '**Note:** Type `/help` for detailed instructions, environment setup, and configuration options.'
+              ].join('\n');
+              
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body: helpMessage
+              });
+              
+              console.log('Quick reference posted successfully');
+            } catch (error) {
+              console.error('Error posting quick reference:', error);
+              core.setFailed(`Failed to post quick reference: ${error.message}`);
+            }