开源项目 stale 的使用教程

开源项目 stale 的使用教程

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

1. 项目的目录结构及介绍

开源项目 stale 的目录结构如下所示：

.
├── .github
│   ├── workflows
│   └── stale.yml
├── .gitattributes
├── .gitignore
├── .licensed.yml
├── .prettierignore
├── .prettierrc.js
├── .versionrc.json
├── CHANGELOG.md
├── CODEOWNERS
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── action.yml
├── jest.config.js
├── package-lock.json
├── package.json
├── tsconfig.app.json
├── tsconfig.json
└── tsconfig.spec.json

• .github/workflows/stale.yml：GitHub Actions 工作流配置文件，用于自动化执行 stale 操作。
• .gitattributes：配置 Git 处理各种文件类型的属性。
• .gitignore：配置 Git 忽略的文件。
• .licensed.yml：配置 licensed 相关的选项。
• .prettierignore：配置 Prettier 忽略的文件。
• .prettierrc.js：配置 Prettier 的规则。
• .versionrc.json：配置版本控制相关的选项。
• CHANGELOG.md：记录项目更新历史。
• CODEOWNERS：配置代码所有者，以便在代码提交时自动通知相关责任人。
• CONTRIBUTING.md：贡献指南，指导贡献者如何参与项目开发。
• LICENSE：项目许可证。
• README.md：项目介绍和说明。
• action.yml：GitHub Action 的配置文件。
• jest.config.js：Jest 测试框架的配置文件。
• package-lock.json：npm 包版本锁定文件。
• package.json：npm 包配置文件。
• tsconfig.app.json、tsconfig.json、tsconfig.spec.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 GitHub Actions 来实现，具体配置在 .github/workflows/stale.yml 文件中。

以下是一个简单的启动文件示例：

name: stale

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

jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: stale
        uses: actions/stale@v1
        with:
          days-before-stale: 60
          days-before-close: 7
          stale-issue-label: 'Stale'
          close-issue-label: 'Closed'
          close-issue-reason: 'not_planned'

这个配置文件设置了一个定时任务，每天检查仓库中的 issues 和 pull requests，标记长时间未活跃的为 stale，并在一定时间后关闭。

3. 项目的配置文件介绍

项目的配置主要通过 action.yml 文件来进行，这个文件定义了 GitHub Action 的输入参数和默认值。

以下是一个配置文件的示例：

name: 'stale'

description: 'Marks issues and pull requests that have not had recent interaction as stale.'

inputs:
  days-before-stale:
    description: 'Idle number of days before marking issues/PRs stale'
    default: 60
  days-before-close:
    description: 'Idle number of days before closing stale issues/PRs'
    default: 7
  stale-issue-label:
    description: 'Label to apply on staled issues'
    default: 'Stale'
  close-issue-label:
    description: 'Label to apply on closed issues'
    default: 'Closed'
  close-issue-reason:
    description: 'Reason to use when closing issues'
    default: 'not_planned'
  # 更多配置...

这个配置文件定义了几个输入参数，包括标记为 stale 的天数、关闭 stale 的天数、stale 的标签、关闭的标签等，用户可以在运行 GitHub Action 时根据需要修改这些参数。

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