Skip to content

Commit ce0b7dd

Browse files
committed
Updated help
1 parent 098b886 commit ce0b7dd

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

.github/workflows/help-command.yml

+18-20
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,6 @@ jobs:
4646
'- Provides a unique URL to preview your changes',
4747
'- Shows build and deployment progress in real-time',
4848
'',
49-
'**Required Environment Secrets:**',
50-
'- `CPLN_TOKEN_STAGING`: Control Plane authentication token',
51-
'- `CPLN_TOKEN_PRODUCTION`: Control Plane authentication token',
52-
'',
53-
'**Required GitHub Actions Variables:**',
54-
'- `CPLN_ORG_STAGING`: Control Plane authentication token',
55-
'- `CPLN_ORG_PRODUCTION`: Control Plane authentication token',
56-
'',
57-
'**Required GitHub Actions Variables (these need to match your control_plane.yml file:**',
58-
'- `PRODUCTION_APP_NAME`: Control Plane production app name',
59-
'- `STAGING_APP_NAME`: Control Plane staging app name',
60-
'- `REVIEW_APP_PREFIX`: Control Plane review app prefix',
61-
'',
6249
'**Optional Configuration:**',
6350
'- `WAIT_TIMEOUT`: Deployment timeout in seconds (default: 900)',
6451
' - Must be a positive integer',
@@ -81,17 +68,28 @@ jobs:
8168
'---',
8269
'## Environment Setup',
8370
'',
84-
'1. Set required secrets in your repository settings:',
85-
' - `CPLN_TOKEN`',
86-
' - `CPLN_ORG`',
71+
'**Required Environment Secrets:**',
72+
'- `CPLN_TOKEN_STAGING`: Control Plane authentication token',
73+
'- `CPLN_TOKEN_PRODUCTION`: Control Plane authentication token',
74+
'',
75+
'**Required GitHub Actions Variables:**',
76+
'- `CPLN_ORG_STAGING`: Control Plane authentication token',
77+
'- `CPLN_ORG_PRODUCTION`: Control Plane authentication token',
78+
'',
79+
'**Required GitHub Actions Variables (these need to match your control_plane.yml file:**',
80+
'- `PRODUCTION_APP_NAME`: Control Plane production app name',
81+
'- `STAGING_APP_NAME`: Control Plane staging app name',
82+
'- `REVIEW_APP_PREFIX`: Control Plane review app prefix',
8783
'',
88-
'2. Optional: Configure `WAIT_TIMEOUT` in GitHub Actions variables to customize deployment timeout',
84+
Optional: Configure `WAIT_TIMEOUT` in GitHub Actions variables to customize deployment timeout',
8985
'',
9086
'## Control Plane Integration',
9187
'',
92-
'Review apps are deployed to Control Plane with the following configuration:',
93-
'- App Name Format: `qa-react-webpack-rails-tutorial-pr-{PR_NUMBER}`',
94-
'- Console URL: `https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info`',
88+
'1. Review app naming convention:',
89+
' ```',
90+
' ${{ vars.REVIEW_APP_PREFIX }}-<pr-number>',
91+
' ```',
92+
'2. Console URL: `https://console.cpln.io/console/org/{CPLN_ORG}/gvc/{APP_NAME}/-info`',
9593
'',
9694
'## Automatic Cleanup',
9795
'',

0 commit comments

Comments
 (0)