Compliment Bot Action

A GitHub Action that generates a random compliment with emojis for developers on every push:)

📝 Usage

Add the following workflow to your .github/workflows directory:

name: Generate Compliment

on:
  pull_request:
    branches: [main, develop]

jobs:
  generate-compliment:
    runs-on: ubuntu-latest
    steps:
      - uses: junjie-w/compliment-bot-action@main
        with:
          developer_name: "Code Wizard"    
          # The name to use in the compliment (required)
          compliment_style: "funny"     
          # Style of compliment (required: enthusiastic/funny/motivational)

Inputs

| Input | Required | Default | Description | |-------|----------|---------|-------------| | developer_name | Yes | "Awesome Developer" | The name of the developer to compliment | | compliment_style | Yes | "enthusiastic" | The style of compliment ("enthusiastic", "funny", or "motivational") |

🛠️ Development

Prerequisites

• Node.js >= 20.8.1
• npm

Setup

1. Clone the repository:

git clone https://github.com/junjie-w/compliment-bot-action.git
cd compliment-bot-action

2. Install dependencies:

npm install

3. Enable Git hooks:

npm run prepare

Scripts

• npm run build - Builds the action using @vercel/ncc
• npm test - Runs Jest tests
• npm run test:coverage - Runs tests with coverage report
• npm run lint - Lints JavaScript and YAML files
• npm run lint:fix - Fixes linting issues automatically

Commit Convention

This project follows the Conventional Commits specification. Commit messages should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types: feat, fix, docs, style, refactor, test, chore

🔧 Contributing

Contributions, issues, and feature requests are welcome. Feel free to check issues page.

📦 Published Package

This action is available on the GitHub Marketplace :)