Discord Auto-Publisher 使用教程

1. 项目介绍

Discord Auto-Publisher 是一个开源项目，旨在帮助用户自动化地在 Discord 服务器上发布内容。这个项目可以自动将 GitHub 仓库中的新提交（commit）或分支更新发布到 Discord 频道，使得团队协作和项目更新通知更为高效和自动化。

2. 项目快速启动

首先，确保你已经安装了 Node.js 和 npm。

# 克隆项目到本地
git clone https://github.com/Vedinsoh/discord-auto-publisher.git

# 进入项目目录
cd discord-auto-publisher

# 安装依赖
npm install

# 在项目根目录下创建一个配置文件 config.json
# 内容如下：
{
  "token": "YOUR_DISCORD_BOT_TOKEN",
  "channelId": "YOUR_DISCORD_CHANNEL_ID",
  "guildId": "YOUR_DISCORD_GUILD_ID",
  "repo": "YOUR_GITHUB_REPOSITORY",
  "branches": ["main", "master"]
}

# 运行项目
npm start

确保在 config.json 文件中替换 YOUR_DISCORD_BOT_TOKEN, YOUR_DISCORD_CHANNEL_ID, YOUR_DISCORD_GUILD_ID, 和 YOUR_GITHUB_REPOSITORY 为你自己的 Discord 机器人的 token、Discord 频道的 ID、Discord 服务器（公会）的 ID 和 GitHub 仓库的名称。

3. 应用案例和最佳实践

• 自动化发布: 当你的团队在 GitHub 仓库中进行了新的提交时，Discord Auto-Publisher 可以自动将更新通知到指定的 Discord 频道。
• 多仓库管理: 你可以为多个 GitHub 仓库配置不同的发布规则，使得不同项目的更新可以发布到不同的 Discord 频道。
• 自定义通知: 可以通过修改配置文件来定制通知的内容和格式，以适应不同的团队沟通需求。

4. 典型生态项目

Discord Auto-Publisher 可以与 GitHub Actions、GitLab CI/CD 等持续集成工具结合使用，形成一个更加完善的项目自动化工作流。通过这种方式，可以在代码合并到主分支、发布新版本等事件发生时自动执行通知任务，从而提高开发效率。