Update inspect.yml 1 #2
Workflow file for this run
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
| ############################################################################## | |
| ############################################################################## | |
| # | |
| # NOTE! | |
| # | |
| # Please read the README.md file in this directory that defines what should | |
| # be placed in this file | |
| # | |
| ############################################################################## | |
| ############################################################################## | |
| name: PR Workflow | |
| on: | |
| pull_request: | |
| branches: | |
| - '**' | |
| env: | |
| CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }} | |
| jobs: | |
| Code-Quality-Checks: | |
| name: Check for linting, formatting, and type errors | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository content | |
| uses: actions/checkout@v3 | |
| - name: Count number of lines | |
| run: | | |
| chmod +x ./.github/workflows/countline.py | |
| ./.github/workflows/countline.py --lines 600 --exclude_files src/types/generatedGraphQLTypes.ts tests | |
| - name: Restore node_modules from cache | |
| id: cache-npm | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-node-modules | |
| with: | |
| path: | | |
| ~/.npm | |
| node_modules | |
| key: ${{ runner.os }}-code-quality-checks-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-code-quality-checks-${{ env.cache-name }}- | |
| ${{ runner.os }}-code-quality-checks- | |
| ${{ runner.os }}- | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Run ESLint to check for linting errors in modified files | |
| run: npx eslint $(git diff --name-only --diff-filter=d ${{ github.event.before }} ${{ github.sha }} -- '***.ts') | |
| - name: Check for formatting errors | |
| run: npm run format:check | |
| - name: Run Typescript Type-Checker | |
| run: npm run typecheck | |
| File-count-check: | |
| name: Counting files changed | |
| runs-on: ubuntu-latest | |
| env: | |
| BASE_BRANCH: ${{ github.event.pull_request.base.ref }} | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v2 | |
| - name: Checkout code | |
| run: git fetch origin pull/${{ github.event.pull_request.number }}/head:pr-branch | |
| working-directory: ${{ github.workspace }} | |
| - name: Setup Python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.11.6' | |
| - name: Compare changes between Base branch and PR Head. | |
| id: changed-files-base | |
| run: | | |
| git fetch origin $BASE_BRANCH | |
| git checkout $BASE_BRANCH | |
| python .github/workflows/check_files_submitted.py \ | |
| --base_branch $BASE_BRANCH --pr_branch pr-branch | |
| Test-Application: | |
| name: Testing Application | |
| runs-on: ubuntu-latest | |
| needs: [Code-Quality-Checks] | |
| strategy: | |
| matrix: | |
| node-version: [20.x] | |
| services: | |
| mongo: | |
| image: mongo:4.4 | |
| options: >- | |
| --health-cmd mongo | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 10 | |
| ports: | |
| - 27017:27017 | |
| redis: | |
| image: redis:6.0 | |
| options: >- | |
| --health-cmd "redis-cli ping" | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 10 | |
| ports: | |
| - 6379:6379 | |
| env: | |
| MONGO_DB_URL: mongodb://localhost:27017/talawa-test-db | |
| REDIS_HOST: localhost | |
| REDIS_PORT: 6379 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Generate Access Token Secret | |
| run: echo "ACCESS_TOKEN_SECRET=$(openssl rand -hex 32)" >> $GITHUB_ENV | |
| - name: Generate Refresh Token Secret | |
| run: echo "REFRESH_TOKEN_SECRET=$(openssl rand -hex 32)" >> $GITHUB_ENV | |
| - name: Set up Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v3 | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Sleep for 10s | |
| uses: juliangruber/sleep-action@v1 | |
| with: | |
| time: 10s | |
| - name: Run the tests | |
| run: npm run test | |
| - name: Import Sample Data | |
| run: npm run import:sample-data | |
| - name: Present and upload coverage to Codecov as ${{env.CODECOV_UNIQUE_NAME}} | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| verbose: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: false | |
| name: '${{env.CODECOV_UNIQUE_NAME}}' | |
| - name: Test acceptable level of code coverage | |
| uses: VeryGoodOpenSource/very_good_coverage@v2 | |
| with: | |
| path: './coverage/lcov.info' | |
| min_coverage: 95.0 | |
| JSDocs: | |
| name: 'JSDocs comments and pipeline' | |
| runs-on: ubuntu-latest | |
| needs: Test-Application | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: 'Check whether comments exists for JSDocs' | |
| run: | | |
| chmod +x ./.github/workflows/check-jsdocs-comment.py | |
| ./.github/workflows/check-jsdocs-comment.py | |
| - name: 'Run JSDocs' | |
| if: env.RUN_JSDOCS == 'True' | |
| run: echo "Run JSdocs :${{ env.RUN_JSDOCS }}" | |
| Branch-check: | |
| name: "Base branch check" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Check if base branch is develop" | |
| if: github.event.pull_request.base.ref != 'develop' | |
| run: | | |
| echo "PR is not against develop branch. Please refer PR_GUIDELINES.md" | |
| exit 1 | |