From edf36517eb854623c8c8cad785f1178dc24853cd Mon Sep 17 00:00:00 2001 From: Daphne Yang Date: Wed, 14 Feb 2024 17:31:34 -0500 Subject: [PATCH] chore: add note in Base Suite workflow that OS input must be a valid JSON array --- .github/workflows/baseSuiteE2E.yml | 84 +++++++++++++++--------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/.github/workflows/baseSuiteE2E.yml b/.github/workflows/baseSuiteE2E.yml index cc820b0b..a242af5b 100644 --- a/.github/workflows/baseSuiteE2E.yml +++ b/.github/workflows/baseSuiteE2E.yml @@ -11,51 +11,51 @@ on: workflow_dispatch: inputs: automationBranch: - description: "Set the branch to use for automation tests" + description: 'Set the branch to use for automation tests' required: false - default: "develop" + default: 'develop' type: string anInitialSuite: - description: "Verify Extensions" + description: 'Verify Extensions' required: false default: true type: boolean authentication: - description: "Authentication" + description: 'Authentication' required: false default: true type: boolean templates: - description: "Create Commands" + description: 'Create Commands' required: false default: true type: boolean deployAndRetrieve: - description: "Deploy and Retrieve" + description: 'Deploy and Retrieve' required: false default: true type: boolean apexLsp: - description: "Apex LSP" + description: 'Apex LSP' required: false default: true type: boolean runApexTests: - description: "Run Apex Tests" + description: 'Run Apex Tests' required: false default: true type: boolean vscodeVersion: - description: "VSCode Version" + description: 'VSCode Version' required: false - default: "1.82.3" + default: '1.82.3' type: string runId: - description: "Run ID of the workflow run that created the vsixes" + description: 'Run ID of the workflow run that created the vsixes' required: true type: string os: - description: "Operating System(s) to run the E2E tests on" + description: 'Operating System(s) to run the E2E tests on. Input must be a valid JSON array.' required: false default: '["ubuntu-latest"]' type: string @@ -63,51 +63,51 @@ on: workflow_call: inputs: automationBranch: - description: "Set the branch to use for automation tests" + description: 'Set the branch to use for automation tests' required: false - default: "develop" + default: 'develop' type: string anInitialSuite: - description: "Verify Extensions" + description: 'Verify Extensions' required: false default: true type: boolean authentication: - description: "Authentication" + description: 'Authentication' required: false default: true type: boolean templates: - description: "Create Commands" + description: 'Create Commands' required: false default: true type: boolean deployAndRetrieve: - description: "Deploy and Retrieve" + description: 'Deploy and Retrieve' required: false default: true type: boolean apexLsp: - description: "Apex LSP" + description: 'Apex LSP' required: false default: true type: boolean runApexTests: - description: "Run Apex Tests" + description: 'Run Apex Tests' required: false default: true type: boolean vscodeVersion: - description: "VSCode Version" + description: 'VSCode Version' required: false - default: "1.82.3" + default: '1.82.3' type: string runId: - description: "Run ID of the workflow run that created the vsixes" + description: 'Run ID of the workflow run that created the vsixes' required: true type: string os: - description: "Operating System(s) to run the E2E tests on" + description: 'Operating System(s) to run the E2E tests on. Input must be a valid JSON array.' required: false default: '["ubuntu-latest"]' type: string @@ -119,7 +119,7 @@ jobs: secrets: inherit with: automationBranch: ${{ inputs.automationBranch || github.event_name == 'workflow_run' }} - testToRun: "anInitialSuite.e2e.ts" + testToRun: 'anInitialSuite.e2e.ts' vscodeVersion: ${{ inputs.vscodeVersion || '1.82.3' }} runId: ${{ inputs.runId }} os: ${{ inputs.os || '["ubuntu-latest"]' }} @@ -130,7 +130,7 @@ jobs: secrets: inherit with: automationBranch: ${{ inputs.automationBranch }} - testToRun: "authentication.e2e.ts" + testToRun: 'authentication.e2e.ts' vscodeVersion: ${{ inputs.vscodeVersion || '1.82.3' }} runId: ${{ inputs.runId }} os: ${{ inputs.os || '["ubuntu-latest"]' }} @@ -141,7 +141,7 @@ jobs: secrets: inherit with: automationBranch: ${{ inputs.automationBranch }} - testToRun: "templates.e2e.ts" + testToRun: 'templates.e2e.ts' vscodeVersion: ${{ inputs.vscodeVersion || '1.82.3' }} runId: ${{ inputs.runId }} os: ${{ inputs.os || '["ubuntu-latest"]' }} @@ -152,7 +152,7 @@ jobs: secrets: inherit with: automationBranch: ${{ inputs.automationBranch }} - testToRun: "deployAndRetrieve.e2e.ts" + testToRun: 'deployAndRetrieve.e2e.ts' vscodeVersion: ${{ inputs.vscodeVersion || '1.82.3' }} runId: ${{ inputs.runId }} os: ${{ inputs.os || '["ubuntu-latest"]' }} @@ -163,7 +163,7 @@ jobs: secrets: inherit with: automationBranch: ${{ inputs.automationBranch }} - testToRun: "apexLsp.e2e.ts" + testToRun: 'apexLsp.e2e.ts' vscodeVersion: ${{ inputs.vscodeVersion || '1.82.3' }} runId: ${{ inputs.runId }} os: ${{ inputs.os || '["ubuntu-latest"]' }} @@ -174,7 +174,7 @@ jobs: secrets: inherit with: automationBranch: ${{ inputs.automationBranch }} - testToRun: "runApexTests.e2e.ts" + testToRun: 'runApexTests.e2e.ts' vscodeVersion: ${{ inputs.vscodeVersion || '1.82.3' }} runId: ${{ inputs.runId }} os: ${{ inputs.os || '["ubuntu-latest"]' }} @@ -193,12 +193,12 @@ jobs: uses: ./.github/workflows/slackNotification.yml secrets: inherit with: - title: "Base E2E Test Suite" + title: 'Base E2E Test Suite' testsBranch: ${{ inputs.automationBranch }} summary: '\n- An Initial Suite: ${{ needs.anInitialSuite.result }}\n- Authentication: ${{ needs.authentication.result }}\n- Templates: ${{ needs.templates.result }}\n- Deploy and Retrieve: ${{ needs.deployAndRetrieve.result }}\n- Apex LSP: ${{ needs.apexLSP.result }}\n- Run Apex Tests: ${{ needs.runApexTests.result }}' - result: "All the tests passed." - workflow: "actions/runs/${{ github.run_id }}" - type: "e2e" + result: 'All the tests passed.' + workflow: 'actions/runs/${{ github.run_id }}' + type: 'e2e' slack_failure_notification: if: ${{ failure() }} @@ -214,12 +214,12 @@ jobs: uses: ./.github/workflows/slackNotification.yml secrets: inherit with: - title: "Base E2E Test Suite" + title: 'Base E2E Test Suite' testsBranch: ${{ inputs.automationBranch }} summary: '\n- An Initial Suite: ${{ needs.anInitialSuite.result }}\n- Authentication: ${{ needs.authentication.result }}\n- Templates: ${{ needs.templates.result }}\n- Deploy and Retrieve: ${{ needs.deployAndRetrieve.result }}\n- Apex LSP: ${{ needs.apexLSP.result }}\n- Run Apex Tests: ${{ needs.runApexTests.result }}' - result: "Not all the tests passed." - workflow: "actions/runs/${{ github.run_id }}" - type: "e2e" + result: 'Not all the tests passed.' + workflow: 'actions/runs/${{ github.run_id }}' + type: 'e2e' slack_cancelled_notification: if: ${{ cancelled() }} @@ -235,9 +235,9 @@ jobs: uses: ./.github/workflows/slackNotification.yml secrets: inherit with: - title: "Base E2E Test Suite" + title: 'Base E2E Test Suite' testsBranch: ${{ inputs.automationBranch }} summary: '\n- An Initial Suite: ${{ needs.anInitialSuite.result }}\n- Authentication: ${{ needs.authentication.result }}\n- Templates: ${{ needs.templates.result }}\n- Deploy and Retrieve: ${{ needs.deployAndRetrieve.result }}\n- Apex LSP: ${{ needs.apexLSP.result }}\n- Run Apex Tests: ${{ needs.runApexTests.result }}' - result: "The workflow was cancelled." - workflow: "actions/runs/${{ github.run_id }}" - type: "e2e" + result: 'The workflow was cancelled.' + workflow: 'actions/runs/${{ github.run_id }}' + type: 'e2e'