doc: added descriptions #108
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Unique name for this workflow | |
| name: CI | |
| # Definition when the workflow should run | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| paths-ignore: | |
| - 'sfdx-project.json' | |
| - 'README.md' | |
| # Jobs to be executed | |
| jobs: | |
| format-lint-lwc-tests: | |
| runs-on: trailheadapps-Ubuntu | |
| steps: | |
| # Checkout the source code | |
| - name: 'Checkout source code' | |
| uses: actions/checkout@v3 | |
| # Install Volta to enforce proper node and package manager versions | |
| - name: 'Install Volta' | |
| uses: volta-cli/action@v4 | |
| # Cache node_modules to speed up the process | |
| - name: 'Restore node_modules cache' | |
| id: cache-npm | |
| uses: actions/cache@v3 | |
| with: | |
| path: node_modules | |
| key: npm-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| npm-${{ env.cache-name }}- | |
| npm- | |
| # Install npm dependencies for Prettier and Jest | |
| - name: 'Install npm dependencies' | |
| if: steps.cache-npm.outputs.cache-hit != 'true' | |
| run: HUSKY=0 npm ci | |
| # Prettier formatting | |
| - name: 'Code formatting verification with Prettier' | |
| run: npm run prettier:verify | |
| # Lint LWC / Aura | |
| - name: 'Lint Lightning Web Components / Aura Components' | |
| run: npm run lint | |
| # LWC unit tests | |
| - name: 'Unit test Lightning Web Components' | |
| run: npm run test:unit:coverage | |
| # Upload code coverage data | |
| - name: 'Upload code coverage for LWC to Codecov.io' | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| flags: LWC | |
| scratch-org-test: | |
| runs-on: trailheadapps-Ubuntu | |
| needs: format-lint-lwc-tests | |
| if: github.actor != 'dependabot[bot]' | |
| steps: | |
| # Install Salesforce CLI | |
| - name: 'Install Salesforce CLI' | |
| run: | | |
| npm install @salesforce/cli --location=global | |
| nodeInstallPath=$(npm config get prefix) | |
| echo "$nodeInstallPath/bin" >> $GITHUB_PATH | |
| sf --version | |
| # Checkout the source code | |
| - name: 'Checkout source code' | |
| uses: actions/checkout@v3 | |
| # Store secret for dev hub | |
| - name: 'Populate auth file with DEVHUB_SFDX_URL secret' | |
| shell: bash | |
| run: | | |
| echo ${{ secrets.DEVHUB_SFDX_URL }} > ./DEVHUB_SFDX_URL.txt | |
| secretFileSize=$(wc -c "./DEVHUB_SFDX_URL.txt" | awk '{print $1}') | |
| if [ $secretFileSize == 1 ]; then | |
| echo "Missing DEVHUB_SFDX_URL secret. Is this workflow running on a fork?"; | |
| exit 1; | |
| fi | |
| # Authenticate dev hub | |
| - name: 'Authenticate Dev Hub' | |
| run: sf org login sfdx-url -f ./DEVHUB_SFDX_URL.txt -a devhub -d | |
| # Create scratch org | |
| - name: 'Create scratch org' | |
| run: sf org create scratch -f config/project-scratch-def.json -a scratch-org -d -y 1 | |
| # Deploy source to scratch org | |
| - name: 'Push source to scratch org' | |
| run: sf project deploy start | |
| # Assign permissionset | |
| - name: 'Assign permissionset to default user' | |
| run: sf org assign permset -n dreamhouse | |
| # Import sample data | |
| - name: 'Import sample data' | |
| run: sf data tree import -p ./data/sample-data-plan.json | |
| # Run Apex tests in scratch org | |
| - name: 'Run Apex tests' | |
| run: sf apex test run -c -r human -d ./tests/apex -w 20 | |
| # Upload code coverage data | |
| - name: 'Upload code coverage for Apex to Codecov.io' | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| flags: Apex | |
| # Housekeeping | |
| - name: 'Delete scratch org' | |
| if: always() | |
| run: sf org delete scratch -p -o scratch-org | |
| trigger-packaging: | |
| runs-on: trailheadapps-Ubuntu | |
| needs: scratch-org-test | |
| steps: | |
| # Checkout the source code | |
| - name: 'Checkout source code' | |
| uses: actions/checkout@v3 | |
| # Check for package changes using git diff | |
| - name: 'Check for package changes' | |
| id: checkForChanges | |
| run: | | |
| git fetch origin ${{ github.event.before }} --depth=1 | |
| changedPaths=$( git diff-tree --name-only ${{ github.event.before }} $GITHUB_SHA ) | |
| set +e | |
| hasChanges='false' | |
| if [ $(echo "$changedPaths" | grep -c '^force-app') == 1 ]; then | |
| hasChanges='true' | |
| fi | |
| echo "hasChanges=$hasChanges" >> $GITHUB_OUTPUT | |
| # Trigger packaging workflow if needed | |
| - name: 'Trigger packaging workflow if needed' | |
| uses: peter-evans/repository-dispatch@v2 | |
| if: steps.checkForChanges.outputs.hasChanges == 'true' | |
| with: | |
| token: ${{ secrets.BOT_ACCESS_TOKEN }} | |
| event-type: start-packaging | |
| client-payload: '{ "ref": "${{ github.ref }}", "sha": "${{ github.sha }}" }' |