https://github.com/circa10a/animal-action

A github action to add smiles to pull requests
https://github.com/circa10a/animal-action

Last synced: 10 months ago
JSON representation

A github action to add smiles to pull requests

• Host: GitHub
• URL: https://github.com/circa10a/animal-action
• Owner: circa10a
• License: mit
• Created: 2021-11-08T21:32:15.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-11-12T01:48:49.000Z (over 4 years ago)
• Last Synced: 2025-09-26T08:45:08.662Z (10 months ago)
• Language: JavaScript
• Size: 2.18 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# animal-action

![Build Status](https://github.com/circa10a/animal-action/workflows/release/badge.svg)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/circa10a/animal-action?style=plastic)

A github action to add smiles to pull requests

![alt text](docs/img/example.png)

## Inputs

## `github_token`

**Required** A GitHub token

## `animals`

A comma-delimated string of types of animals pictures to comment with.

Default: `"cats,dogs,foxes"`.

## `pull_request_comment`

Comment to post along with animal picture.

Default: `':tada: Thank you for your contribution! While we review, please enjoy this cute animal picture'`.

## Outputs

None

## Example usage

```yaml

name: comment

on:

  pull_request:

    types: [opened]

jobs:

  comment:

    runs-on: ubuntu-latest

    steps:

      - uses: circa10a/animal-action@main

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          animals: 'cats,dogs' # cats,dogs,foxes currently supported

          pull_request_comment: ':tada: Thank you for the contribution! Here's a cute animal picture to say thank you!'

```