From 0d26d4cdbd051337de824b9113cb0473dbec456c Mon Sep 17 00:00:00 2001 From: Liyas Thomas Date: Wed, 14 Dec 2022 19:10:52 +0530 Subject: [PATCH] ci: updated workflow comments --- .github/workflows/codeql-analysis.yml | 2 +- .../workflows/deploy-firebase-production.yml | 5 +++-- .../workflows/deploy-netlify-production.yml | 20 ++++++++++++------- .github/workflows/deploy-netlify-staging.yml | 18 +++++++++++------ .github/workflows/publish-docker.yml | 6 +++--- .github/workflows/tests.yml | 13 ++++++------ 6 files changed, 39 insertions(+), 25 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 8f4524e27..ec5e254ef 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -32,7 +32,7 @@ jobs: contents: read steps: - - name: Checkout repository + - name: Checkout uses: actions/checkout@v3 # Initializes the CodeQL tools for scanning. diff --git a/.github/workflows/deploy-firebase-production.yml b/.github/workflows/deploy-firebase-production.yml index e8dd9d6cc..c72ccb2db 100644 --- a/.github/workflows/deploy-firebase-production.yml +++ b/.github/workflows/deploy-firebase-production.yml @@ -5,10 +5,11 @@ on: branches: [main] jobs: - deploy_live_website: + deploy: + name: Deploy runs-on: ubuntu-latest steps: - - name: Checkout Repository + - name: Checkout uses: actions/checkout@v3 - name: Deploy to Firebase (production) diff --git a/.github/workflows/deploy-netlify-production.yml b/.github/workflows/deploy-netlify-production.yml index d5d0136da..6e4309792 100644 --- a/.github/workflows/deploy-netlify-production.yml +++ b/.github/workflows/deploy-netlify-production.yml @@ -5,23 +5,29 @@ on: branches: [main] jobs: - build: - name: Push build files to Netlify + deploy: + name: Deploy runs-on: ubuntu-latest steps: - - name: Checkout Repository + - name: Checkout uses: actions/checkout@v3 - - name: Setup Environment + - name: Setup environment run: mv .env.example .env - - name: Setup and run pnpm install + - name: Setup pnpm uses: pnpm/action-setup@v2.2.4 with: version: 7 run_install: true - - name: Build Site + - name: Setup node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node }} + cache: pnpm + + - name: Build site env: VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }} VITE_SENTRY_ENVIRONMENT: production @@ -35,7 +41,7 @@ jobs: NETLIFY_SITE_ID: ${{ secrets.NETLIFY_PRODUCTION_SITE_ID }} NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - - name: Create Sentry Release + - name: Create Sentry release uses: getsentry/action-release@v1 env: SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }} diff --git a/.github/workflows/deploy-netlify-staging.yml b/.github/workflows/deploy-netlify-staging.yml index 510233ac5..a0b70e4a7 100644 --- a/.github/workflows/deploy-netlify-staging.yml +++ b/.github/workflows/deploy-netlify-staging.yml @@ -7,14 +7,14 @@ on: branches: [staging] jobs: - build: - name: Push build files to Netlify + deploy: + name: Deploy runs-on: ubuntu-latest steps: - - name: Checkout Repository + - name: Checkout uses: actions/checkout@v3 - - name: Setup and run pnpm install + - name: Setup pnpm uses: pnpm/action-setup@v2.2.4 env: VITE_BACKEND_GQL_URL: ${{ secrets.STAGING_BACKEND_GQL_URL }} @@ -22,7 +22,13 @@ jobs: version: 7 run_install: true - - name: Build Site + - name: Setup node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node }} + cache: pnpm + + - name: Build site env: VITE_GA_ID: ${{ secrets.STAGING_GA_ID }} VITE_GTM_ID: ${{ secrets.STAGING_GTM_ID }} @@ -48,7 +54,7 @@ jobs: NETLIFY_SITE_ID: ${{ secrets.NETLIFY_STAGING_SITE_ID }} NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - - name: Create Sentry Release + - name: Create Sentry release uses: getsentry/action-release@v1 env: SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }} diff --git a/.github/workflows/publish-docker.yml b/.github/workflows/publish-docker.yml index 5910a7e18..01566d59e 100644 --- a/.github/workflows/publish-docker.yml +++ b/.github/workflows/publish-docker.yml @@ -7,8 +7,8 @@ on: types: [published] jobs: - push_to_registry: - name: Push Docker image to Docker Hub + publish: + name: Publish runs-on: ubuntu-latest steps: - name: Maximize build space @@ -20,7 +20,7 @@ jobs: remove-android: 'true' remove-haskell: 'true' - - name: Check out the repo + - name: Checkout uses: actions/checkout@v3 - name: Set up QEMU diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 2c0984aa6..2faac5bbd 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -7,7 +7,8 @@ on: branches: [main, staging] jobs: - build: + test: + name: Test runs-on: ubuntu-latest strategy: @@ -15,22 +16,22 @@ jobs: node-version: ["lts/*"] steps: - - name: Checkout Repository + - name: Checkout uses: actions/checkout@v3 - - name: Setup Environment + - name: Setup environment run: mv .env.example .env - - name: Setup and run pnpm install + - name: Setup pnpm uses: pnpm/action-setup@v2.2.4 with: version: 7 run_install: true - - name: Use Node.js ${{ matrix.node-version }} + - name: Setup node uses: actions/setup-node@v3 with: - node-version: ${{ matrix.node-version }} + node-version: ${{ matrix.node }} cache: pnpm - name: Run tests