codfish/actions

A collection of reusable GitHub Actions for common development workflows. Each action is self-contained and designed for maximum reusability across different projects.

Table of Contents

• Usage
• Available Actions
  • comment
  • npm-pr-version
  • setup-node-and-install
• Contributing
• Example Workflow

Usage

Reference actions using the following format:

uses: codfish/actions/{action-name}@main
uses: codfish/actions/{action-name}@v2
uses: codfish/actions/{action-name}@v2.0.1
uses: codfish/actions/{action-name}@feature-branch
uses: codfish/actions/{action-name}@aff1a9d

Available Actions

comment

Creates or updates a comment in a pull request with optional tagging for upsert functionality

Inputs:

Input	Description	Required	Default
message	The comment message content (supports markdown formatting)	Yes	-
tag	Unique identifier to find and update existing comments (required when upsert is true)	No	-
upsert	Update existing comment with matching tag instead of creating new comment	No	false

Usage:

- name: Comment on PR
  uses: codfish/actions/comment@v2
  with:
    message: '✅ Build successful!'
    tag: 'build-status'
    upsert: true

npm-pr-version

Publishes package with PR-specific version (0.0.0-PR-123--abc1234) using detected package manager (npm/yarn/pnpm) and automatically comments on PR

Inputs:

Input	Description	Required	Default
npm-token	Registry authentication token with publish permissions (works with npm/yarn/pnpm)	Yes	-
github-token	GitHub token with pull request comment permissions (typically secrets.GITHUB_TOKEN)	Yes	-
comment	Whether to comment on the PR with the published version (true/false)	No	true
comment-tag	Tag to use for PR comments (for comment identification and updates)	No	npm-publish-pr

Outputs:

Output	Description
version	Generated PR-specific version number (0.0.0-PR-{number}--{short-sha})
package-name	Package name from package.json
error-message	Error message if publish fails

Usage:

steps:
  - uses: actions/checkout@v5

  - uses: codfish/actions/setup-node-and-install@v2
    with:
      node-version: lts/*

  - run: npm run build

  - uses: codfish/actions/npm-pr-version@v2
    with:
      npm-token: ${{ secrets.NPM_TOKEN }}
      github-token: ${{ secrets.GITHUB_TOKEN }}

setup-node-and-install

Sets up Node.js environment and installs dependencies with automatic package manager detection (npm/pnpm/yarn), intelligent caching, and version detection via input, .node-version, .nvmrc, or package.json volta.node

Inputs:

Input	Description	Required	Default
node-version	Node.js version to install (e.g. "24", "lts/*"). Precedence: node-version input > .node-version > .nvmrc > package.json volta.node.	No	-
install-options	Extra command-line options to pass to npm/pnpm/yarn install.	No	-
working-directory	Directory containing package.json and lockfile.	No	.

Outputs:

Output	Description
cache-hit	Whether the dependency cache was hit (true/false).

Usage:

steps:
  - uses: actions/checkout@v5

  # Will setup node, inferring node version from your codebase & installing your dependencies
  - uses: codfish/actions/setup-node-and-install@v2

  # Or if you want to be explicit
  - uses: codfish/actions/setup-node-and-install@v2
    with:
      node-version: 24.4

  - run: npm test

Contributing

Each action follows these conventions:

• Directory structure: Actions are in kebab-case directories at the repository root
• Required files: action.yml, README.md
• Composite actions: All actions use composite type for simplicity and transparency
• Documentation: Each action includes comprehensive usage examples and input/output documentation

Example Workflow

Complete workflow using multiple actions together:

name: CI/CD Pipeline
on:
  pull_request:
    types: [opened, synchronize]

jobs:
  test-and-publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5

      - uses: codfish/actions/setup-node-and-install@v2
        with:
          node-version: 'lts/*'

      - name: Run tests
        run: |
          npm test 2>&1 | tee test-output.txt
          if grep -q "All tests passed" test-output.txt; then
            echo "status=✅ passed" >> $GITHUB_OUTPUT
          else
            echo "status=❌ failed" >> $GITHUB_OUTPUT
          fi
          echo "count=$(grep -c "✓\|√\|PASS" test-output.txt || echo "unknown")" >> $GITHUB_OUTPUT
        id: test

      - name: Build package
        run: npm run build

      - name: Calculate build size
        run: |
          if [ -d "dist" ]; then
            size=$(du -sh dist | cut -f1)
          elif [ -d "build" ]; then
            size=$(du -sh build | cut -f1)
          elif [ -f "package.json" ]; then
            size=$(du -sh . --exclude=node_modules | cut -f1)
          else
            size="unknown"
          fi
          echo "size=$size" >> $GITHUB_OUTPUT
        id: build

      - uses: codfish/actions/comment@v2
        with:
          message: |
            ## 🚀 **Build Summary**

            **Tests**: ${{ steps.test.outputs.status }} (${{ steps.test.outputs.count }} tests)
            **Build**: ✅ completed successfully
            **Size**: ${{ steps.build.outputs.size }}

            Ready for testing! 🎉
          tag: 'build-summary'
          upsert: true

      - uses: codfish/actions/npm-pr-version@v2
        with:
          npm-token: ${{ secrets.NPM_TOKEN }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          comment-tag: 'pr-package'