https://github.com/funnyzak/pushoo-action
A GitHub Action with Pushoo.js pushes multiple platform messages.
https://github.com/funnyzak/pushoo-action
action github-actions message-push push pushoo
Last synced: 11 months ago
JSON representation
A GitHub Action with Pushoo.js pushes multiple platform messages.
- Host: GitHub
- URL: https://github.com/funnyzak/pushoo-action
- Owner: funnyzak
- License: mit
- Created: 2022-09-21T03:30:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-21T15:44:21.000Z (over 2 years ago)
- Last Synced: 2025-03-14T15:54:36.709Z (over 1 year ago)
- Topics: action, github-actions, message-push, push, pushoo
- Language: TypeScript
- Homepage: https://funnyzak.github.io/pushoo-action/
- Size: 2.06 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Pushoo Github Action
A GitHub Action with [Pushoo.js](https://github.com/imaegoo/pushoo) pushes multiple platform messages.
**You also can use [Pushoo CLI](https://github.com/funnyzak/pushoo-cli) to push messages on command line.**
[![action][ci-image]][ci-url]
[![license][license-image]][repository-url]
[![Sourcegraph][sg-image]][sg-url]
[![GitHub repo size][repo-size-image]][repository-url]
[![latest tag][tag-image]][rle-url]
[![GitHub last commit][last-commit-image]][repository-url]
[license-image]: https://img.shields.io/github/license/funnyzak/pushoo-action.svg?style=flat-square
[repository-url]: https://github.com/funnyzak/pushoo-action
[repo-size-image]: https://img.shields.io/github/repo-size/funnyzak/pushoo-action
[down-latest-image]: https://img.shields.io/github/downloads/funnyzak/pushoo-action/latest/total.svg
[down-total-image]: https://img.shields.io/github/downloads/funnyzak/pushoo-action/total.svg
[commit-activity-image]: https://img.shields.io/github/commit-activity/m/funnyzak/pushoo-action?style=flat-square
[last-commit-image]: https://img.shields.io/github/last-commit/funnyzak/pushoo-action?style=flat-square
[license-image]: https://img.shields.io/github/license/funnyzak/pushoo-action.svg?style=flat-square
[repository-url]: https://github.com/funnyzak/pushoo-action
[rle-url]: https://github.com/funnyzak/pushoo-action/releases/latest
[rle-all-url]: https://github.com/funnyzak/pushoo-action/releases
[ci-image]: https://img.shields.io/github/actions/workflow/status/funnyzak/pushoo-cli/ci.yml?branch=main
[ci-url]: https://github.com/funnyzak/pushoo-action/actions
[rle-image]: https://github.com/funnyzak/pushoo-action/actions/workflows/ci.yml/badge.svg
[sg-image]: https://img.shields.io/badge/view%20on-Sourcegraph-brightgreen.svg?style=flat-square
[sg-url]: https://sourcegraph.com/github.com/funnyzak/pushoo-action
[tag-image]: https://img.shields.io/github/v/tag/funnyzak/pushoo-action
## Usage
you can use this action in your workflow like this:
```yml
name: CI
on:
push:
branches:
- main
tags:
- "*"
pull_request:
branches: [main]
workflow_dispatch:
jobs:
push-message:
name: Push Message
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Push Message
uses: funnyzak/pushoo-action@main
with:
platforms: ifttt,wecombot,bark,dingtalk
tokens: ${{ secrets.PUSH_TOKEN }}
content: |
# ${{ github.event.repository.name }} ${{ github.event_name }} Message
## trigger: ${{ github.event_name }} at ${{ github.event.head_commit.timestamp }}
## commit message: ${{ github.event.head_commit.message }}
## commit url: ${{ github.event.head_commit.url }}
## commit author: ${{ github.event.head_commit.author.name }}
## commit email: ${{ github.event.head_commit.author.email }}
## commit id: ${{ github.event.head_commit.id }}
title: |
${{ github.repository }} ${{ github.event_name }} Message
options: '{"bark": { "url": "https://github.com/${{github.repository}}" }, "dingtalk": {"msgtype": "markdown"}}'
debug: false
```
**NOTE:** You need to set the `PUSH_TOKEN` secret in your repository settings.
## Inputs
| Name | Type | Description |
|--------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `platforms` | List/CSV | List of [platforms mapping](https://github.com/imaegoo/pushoo) (e.g., `dingtalk,wecom`) |
| `tokens` | List/CSV | List of [token](https://github.com/imaegoo/pushoo) (e.g., `dingtalk_token_string,wecom_token_string`) |
| `content` | String | The push content of the Markdown format. If the push platform does not support MarkDown, Pushoo will automatically convert to support formats. |
| `title` | String | Optional, message title, if the push platform does not support message title, it will be spliced in the first line of the text. |
| `options` | String | Optional, For some additional configuration when pushing, Json string. |
| `debug` | Boolean | Enable the debug flag to show detail log. |
## Contribution
If you have any ideas or opinions, please refer to Issue or PR.
## License
MIT License © 2022 [funnyzak](https://github.com/funnyzak)