https://github.com/actions-cool/emoji-helper

🤪 Add emoji to Issue、PR、release、comment.
https://github.com/actions-cool/emoji-helper

actions github-actions

Last synced: about 1 year ago
JSON representation

🤪 Add emoji to Issue、PR、release、comment.

• Host: GitHub
• URL: https://github.com/actions-cool/emoji-helper
• Owner: actions-cool
• License: mit
• Created: 2021-06-18T01:46:52.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-07-29T10:39:43.000Z (almost 5 years ago)
• Last Synced: 2025-05-05T19:52:21.368Z (about 1 year ago)
• Topics: actions, github-actions
• Language: JavaScript
• Homepage:
• Size: 69.3 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.en-US.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🤪 Emoji Helper

[简体中文](./README.md) | English

![](https://img.shields.io/github/workflow/status/actions-cool/emoji-helper/CI?style=flat-square)

[![](https://img.shields.io/badge/marketplace-emoji--helper-blueviolet?style=flat-square)](https://github.com/marketplace/actions/emoji-helper)

[![](https://img.shields.io/github/v/release/actions-cool/emoji-helper?style=flat-square&color=orange)](https://github.com/actions-cool/emoji-helper/releases)

Adds emoji to issues, PRs, releases and comments

## 🚀 How to use?

```yml

name: Emoji Helper

on: release

jobs:

  emoji:

    runs-on: ubuntu-latest

    steps:

      - uses: actions-cool/emoji-helper@v1.0.0

        with:

          type: 'release'

          emoji: '+1, laugh, heart, hooray, rocket, eyes'

```

### Inputs

| Name | Description | Required |

| - | - | - |

| token | GitHub token. If not passed, a default token is used. | ✖ |

| type | Event type, one of: `issue`, `pr`, `release` or `comment`. | ✔ |

| emoji | Emoji to add ([see mapping](#emoji-mapping)). | ✔ |

| comment-id | The ID of the item to add the emoji to. | ✖ | 

- `comment-id`：一 Usually tricky to find, so consider [using the helper](https://github.com/actions-cool/issues-helper#find-comments).

## Emoji Mapping

| content | emoji |

| -- | -- |

| `+1` | 👍 |

| `-1` | 👎 |

| `laugh` | 😄 |

| `confused` | 😕 |

| `heart` | ❤️ |

| `hooray` | 🎉 |

| `rocket` | 🚀 |

| `eyes` | 👀 |

## ⚡ Feedback

Any feedback is much appreciated. If you find a bug or want to add a feature, you can so so in the following ways:

- [Creating an issue](https://github.com/actions-cool/emoji-helper/issues) to report a bug

- [Openign a Pull Request](https://github.com/actions-cool/emoji-helper/pulls) to improve the `emoji-helper` action

There's also a DingTalk exchange group (likely in Chinese). Scan below to join.

![](https://github.com/actions-cool/resources/blob/main/dingding.jpeg?raw=true)

## Changelog

The changelog is kept [in a separate file](./CHANGELOG.md)

## License

[MIT](./LICENSE)