《GitHub Actions Stale 项目安装与配置指南》

《GitHub Actions Stale 项目安装与配置指南》

stale Marks issues and pull requests that have not had recent interaction 项目地址: https://gitcode.com/gh_mirrors/stal/stale

1. 项目基础介绍

GitHub Actions Stale 是一个开源项目，用于自动标记和关闭在 GitHub 仓库中长时间未活跃的 Issues 和 Pull Requests。该项目使用 GitHub Actions 来实现自动化流程，主要编程语言为 JavaScript。

2. 项目使用的关键技术和框架

• GitHub Actions: GitHub 提供的持续集成和持续部署平台，允许用户自动化他们的软件工作流程。
• Node.js: 项目使用 Node.js 作为运行环境，执行 JavaScript 代码。
• Express: 一个灵活的 Node.js Web 应用框架，用于处理 HTTP 请求。
• Octokit: 一个 GitHub REST API 的 JavaScript 客户端库。

3. 项目安装和配置准备工作

在开始安装和配置之前，请确保您已经具备以下条件：

• 安装了 Git。
• 拥有一个 GitHub 账户，并且已经创建了一个仓库。
• 具备基本的 Node.js 和 npm（Node.js 包管理器）知识。

详细安装步骤

步骤 1：克隆项目仓库

首先，您需要将项目克隆到本地环境。打开命令行，执行以下命令：

git clone https://github.com/actions/stale.git
cd stale

步骤 2：安装依赖

在项目根目录下，使用 npm 安装项目所需的依赖：

npm install

步骤 3：配置 GitHub Actions 工作流

在您的 GitHub 仓库中，创建一个新的 .github/workflows 目录（如果尚未存在），然后在该目录下创建一个 YAML 文件，例如 stale.yml。以下是一个基础的工作流配置示例：

name: stale

on:
  schedule:
    - cron: '0 0 * * *' # 每天执行一次

jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/stale@v1
        with:
          days-before-stale: '60'
          days-before-close: '7'
          stale-issue-message: 'This issue has been marked as stale due to inactivity. Please respond to this issue to prevent it from being closed.'
          close-issue-message: 'This issue has been closed due to inactivity.'
          # 根据需要添加更多配置项

步骤 4：提交更改

将 .github/workflows/stale.yml 文件添加到您的仓库中，并提交更改：

git add .github/workflows/stale.yml
git commit -m "Add GitHub Actions workflow for stale issues and PRs"
git push origin main

步骤 5：创建个人访问令牌 (PAT)

为了使 GitHub Actions 能够与您的 GitHub 仓库交互，您需要创建一个个人访问令牌。请按照以下步骤操作：

1. 登录您的 GitHub 账户。
2. 转到设置 > Developer settings。
3. 选择 Personal access tokens。
4. 点击 "Generate new token"。
5. 给您的令牌一个描述性的名称，并勾选以下权限：
   • repo:status - 检查提交状态。
   • repo:write - 创建和更新 issues 和 pull requests。
   • repo:admin - 管理仓库的设置。
6. 点击 "Generate token"。

步骤 6：添加仓库秘密

最后，您需要将生成的 PAT 添加为 GitHub 仓库的秘密。请按照以下步骤操作：

1. 转到您的 GitHub 仓库。
2. 点击 "Settings"。
3. 选择 "Secrets and variables"。
4. 点击 "Actions"。
5. 点击 "New secret"。
6. 输入 GITHUB_TOKEN 作为名称，并将您的 PAT 粘贴到值字段中。
7. 点击 "Add secret"。

完成以上步骤后，您的 GitHub Actions 工作流应该就可以自动运行，并开始标记和关闭长时间未活跃的 Issues 和 Pull Requests。

stale Marks issues and pull requests that have not had recent interaction 项目地址: https://gitcode.com/gh_mirrors/stal/stale