Skip to content

Commit

Permalink
ci: improve GitHub Actions workflow descriptions
Browse files Browse the repository at this point in the history
- Made workflow and job names more descriptive
- Added detailed step descriptions for better visibility in GitHub UI
- Clarified tools being used (Biome, TypeScript) in step names
- Improved build step description to indicate production build
  • Loading branch information
supitsdu committed Nov 27, 2024
1 parent d277ed3 commit ebfb37d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
18 changes: 9 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI
name: Build, Test & Quality Checks

on:
push:
Expand All @@ -8,7 +8,7 @@ on:

jobs:
quality:
name: Quality & Build
name: Code Quality & Package Build
runs-on: ubuntu-latest

strategy:
Expand All @@ -18,30 +18,30 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Setup Node.js ${{ matrix.node-version }}
- name: Set up Node.js environment (v${{ matrix.node-version }})
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'

- name: Setup Biome.js
- name: Install Biome.js formatter and linter
uses: biomejs/setup-biome@v2
with:
version: latest

- name: Install dependencies
- name: Install project dependencies
run: npm ci

- name: Run linting & formatting
- name: Verify code style and formatting (Biome)
run: |
npm run lint
npm run format
- name: Run type-checking
- name: Verify TypeScript types
run: npm run check-types

- name: Run tests
- name: Run unit and integration tests
run: npm test

- name: Build package
- name: Build production package
run: npm run build
12 changes: 6 additions & 6 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: Release
name: NPM Package Release

on:
release:
types: [published]

jobs:
publish:
name: NPM Publish
name: Build & Publish to NPM Registry

runs-on: ubuntu-latest

Expand All @@ -21,20 +21,20 @@ jobs:
steps:
- uses: actions/checkout@v4 # Check out the repository code

- name: Setup Node.js ${{ matrix.node-version }}
- name: Set up Node.js environment (v${{ matrix.node-version }})
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
registry-url: "https://registry.npmjs.org"
cache: "npm"

- name: Install dependencies
- name: Install project dependencies
run: npm ci

- name: Build the project (if applicable)
- name: Build production package
run: npm run build --if-present

- name: Publish to npm
- name: Publish package to NPM Registry
run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

0 comments on commit ebfb37d

Please sign in to comment.