🎨 Lint checking on 1056 #357
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
| # Workflow Name: Lint | |
| # Trigger: Pull requests to the main branch that modify specific files (listed in paths). | |
| # | |
| # Environment: | |
| # environment: set to dev | |
| # timezone: retrieved from vars.TIMEZONE | |
| # | |
| # Setup Test Infrastructure: | |
| # Name: Infrastructure setup | |
| # Runs on: ubuntu-latest | |
| # Outputs environment and timezone variables for use in subsequent jobs. | |
| # Steps: | |
| # Echoes the environment and timezone for verification. | |
| # | |
| # Lint: | |
| # Name: Scanning | |
| # Depends on: setup | |
| # Runs on: ubuntu-latest | |
| # Steps: | |
| # Sets the timezone using the specified value. | |
| # Checks out the repository code. | |
| # Sets up the specified Node.js version. | |
| # Installs dependencies using npm run ci:all. | |
| # Runs linting using the command npm run lint | |
| # | |
| # Prettier: | |
| # Name: Prettier | |
| # Depends on: setup | |
| # Runs on: ubuntu-latest | |
| # Steps: | |
| # Sets the timezone using the specified value. | |
| # Checks out the repository code. | |
| # Sets up the specified Node.js version. | |
| # Installs dependencies using npm run ci:all. | |
| # Runs prettier using the command npm run prettier. | |
| # | |
| # Key Points: | |
| # The workflow focuses on linting, which checks code for potential errors, style issues, and adherence to best practices. | |
| # It uses a sequential structure, with the linting job depending on the setup job. | |
| # Environment variables are shared between jobs for consistency. | |
| # The workflow leverages actions from the GitHub Marketplace for setting the timezone and installing Node.js. | |
| # | |
| name: Lint | |
| run-name: 🎨 Lint checking on ${{ github.event.number }} | |
| on: | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - "src/**" | |
| - "test/**" | |
| env: | |
| environment: "qa" | |
| TIMEZONE: ${{ vars.TIMEZONE }} | |
| jobs: | |
| # 1. Setup test infrastructure | |
| setup: | |
| name: Infrastructure setup 🔧 | |
| runs-on: ubuntu-latest | |
| outputs: | |
| environment: ${{ env.environment }} | |
| timezone: ${{ env.timezone }} | |
| steps: | |
| - name: Environment 🧪 | |
| run: echo "Environment set to ${{ env.environment }}" | |
| - name: Timezone 🌐 | |
| run: echo "Timezone set to ${{ env.timezone }}" | |
| # 2. Lint | |
| lint: | |
| name: Scanning 🎨 | |
| environment: | |
| name: ${{ needs.setup.outputs.environment }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Timezone | |
| uses: szenius/[email protected] | |
| with: | |
| timezoneLinux: ${{ needs.setup.outputs.timezone }} | |
| - name: Repository | |
| uses: actions/checkout@v4 | |
| - name: Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ vars.NODE_VERSION }} | |
| - name: Dependencies | |
| working-directory: ./ | |
| run: npm ci --legacy-peer-deps | |
| - name: Linting | |
| working-directory: ./ | |
| run: npm run lint | |
| # 3. Prettier | |
| prettier: | |
| name: Prettier 🎨 | |
| environment: | |
| name: ${{ needs.setup.outputs.environment }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Timezone | |
| uses: szenius/[email protected] | |
| with: | |
| timezoneLinux: ${{ needs.setup.outputs.timezone }} | |
| - name: Repository | |
| uses: actions/checkout@v4 | |
| - name: Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ vars.NODE_VERSION }} | |
| - name: Dependencies | |
| working-directory: ./ | |
| run: npm ci --legacy-peer-deps | |
| - name: Linting | |
| working-directory: ./ | |
| run: npm run prettier |