# v2ex-action

**Repository Path**: yanglbme/v2ex-action

## Basic Information

- **Project Name**: v2ex-action
- **Description**: 🔝 V2EX GitHub Action | 自动发送 V2EX 热门内容到企业微信、钉钉等，可自定义发送周期
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-02-25
- **Last Updated**: 2024-03-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <a href="https://github.com/yanglbme/v2ex-action">
    <img src="./images/logo.png">
  </a>
</p>

<h1 align="center">V2EX Action</h1>

<div align="center">

[![v2ex status](https://github.com/yanglbme/reading/workflows/V2ex/badge.svg)](https://github.com/yanglbme/v2ex-action/actions) [![release](https://img.shields.io/github/v/release/yanglbme/v2ex-action.svg)](../../releases) [![license](https://badgen.net/github/license/yanglbme/v2ex-action)](./LICENSE) [![PRs Welcome](https://badgen.net/badge/PRs/welcome/green)](../../pulls)

</div>

自动将 [V 站](https://v2ex.com)热门发送到指定的 webhook 地址，如企业微信群机器人。可配置 workflow 的触发条件为 `schedule`，实现周期性定时发送热门内容。欢迎 Star ⭐ 关注本项目。

V2EX Action 支持钉钉机器人、企业微信机器人、飞书机器人三种 webhook。

## 入参

| 参数      | 描述         | 是否必传 | 默认值 |
| --------- | ------------ | -------- | ------ |
| `webhook` | Webhook 地址 | 是       | -      |
| `secret`  | 签名密钥     | 否       | ''     |
| `count`   | 帖子数量     | 否       | 8      |

若是钉钉，务必**提供签名密钥**，企业微信则无须提供，飞书则可提供亦可不提供。

![](./images/dingding_secret.png)

## 完整示例

在你的任意一个 GitHub 仓库 `.github/workflows/` 文件夹下创建一个 .yml 文件，如 `v2ex.yml`，内容如下：

```yml
name: V2ex

on:
  schedule:
    # 可自定义 cron 表达式
    - cron: "0 2 * * *"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: yanglbme/v2ex-action@main
        with:
          webhook: ${{ secrets.WEBHOOK }}
          secret: ${{ secrets.SECRET }}
          count: 6
```

注意：

- cron 是 UTC 时间，使用时请将北京时间转换为 UTC 进行配置。由于 GitHub Actions 的限制，如果将 cron 设置为 `* * * * *`，则实际的执行频率为每 5 分钟执行一次。

  ```bash
  ┌───────────── 分钟 (0 - 59)
  │ ┌───────────── 小时 (0 - 23)
  │ │ ┌───────────── 日 (1 - 31)
  │ │ │ ┌───────────── 月 (1 - 12 或 JAN-DEC)
  │ │ │ │ ┌───────────── 星期 (0 - 6 或 SUN-SAT)
  │ │ │ │ │
  │ │ │ │ │
  │ │ │ │ │
  * * * * *
  ```

- 请在项目的 `Settings -> Secrets` 路径下配置好 `WEBHOOK` 与 `SECRET`(仅钉钉机器人要配置)，不要直接在 `.yml` 文件中暴露地址跟密钥。

  ![](./images/config.png)

## 效果

<table>
  <tr>
    <td align="center" style="width: 400px;">
      <a href="https://ding-doc.dingtalk.com/doc#/serverapi3/iydd5h">
        <img src="./images/dingding_res.png" style="width: 360px;"><br>
        <sub>钉钉</sub>
      </a>
    </td>
    <td align="center" style="width: 400px;">
      <a href="https://work.weixin.qq.com/api/doc/90000/90136/91770">
        <img src="./images/qyweixin_res.png" style="width: 360px;"><br>
        <sub>企业微信</sub>
      </a>
    </td>
    <td align="center" style="width: 400px;">
      <a href="https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN?lang=zh-CN">
        <img src="./images/feishu_res.png" style="width: 360px;"><br>
        <sub>飞书</sub>
      </a>
    </td>
  </tr>
</table>

## 联系我

对于 Gitee Pages Action 有任何的疑问，还可以通过以下方式找到我。

<table>
  <tr>
    <td align="center" style="width: 260px;">
      <img src="https://cdn-doocs.oss-cn-shenzhen.aliyuncs.com/gh/doocs/images/qrcode-for-doocs.png" style="width: 400px;"><br>
    </td>
    <td align="center" style="width: 260px;">
      <img src="https://cdn-doocs.oss-cn-shenzhen.aliyuncs.com/gh/doocs/images/qrcode-for-yanglbme.png" style="width: 400px;"><br>
    </td>
  </tr>
</table>

## 许可证

[MIT](LICENSE)