mirror of
https://gitea.com/Lydanne/issues-helper.git
synced 2025-08-19 18:25:58 +08:00
54 lines
46 KiB
HTML
54 lines
46 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta
|
||
name="viewport"
|
||
content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no"
|
||
/>
|
||
<link
|
||
rel="shortcut icon"
|
||
type="image/x-icon"
|
||
href="https://avatars1.githubusercontent.com/u/73879334?s=200&v=4"
|
||
/>
|
||
<link rel="stylesheet" href="/issues-helper/umi.08a4da53.css" />
|
||
<script>
|
||
window.routerBase = "/issues-helper/";
|
||
</script>
|
||
<script>
|
||
//! umi version: 3.5.17
|
||
</script>
|
||
<script>
|
||
!(function () {
|
||
var e = localStorage.getItem("dumi:prefers-color"),
|
||
t = window.matchMedia("(prefers-color-scheme: dark)").matches,
|
||
r = ["light", "dark", "auto"];
|
||
document.documentElement.setAttribute(
|
||
"data-prefers-color",
|
||
e === r[2] ? (t ? r[1] : r[0]) : r.indexOf(e) > -1 ? e : r[0]
|
||
);
|
||
})();
|
||
</script>
|
||
<title>🌟 进 阶</title>
|
||
</head>
|
||
<body>
|
||
<div id="root"><div class="__dumi-default-layout" data-route="/advanced" data-show-sidemenu="true" data-show-slugs="false" data-site-mode="true" data-gapless="false"><div class="__dumi-default-navbar" data-mode="site"><button class="__dumi-default-navbar-toggle"></button><a class="__dumi-default-navbar-logo" style="background-image:url('https://avatars1.githubusercontent.com/u/73879334?s=200&v=4')" href="/issues-helper//">Issues Helper</a><nav><div class="__dumi-default-search"><input type="search" class="__dumi-default-search-input" value=""/><ul></ul></div><span><a href="/issues-helper//guide">指 南</a></span><span><a href="/issues-helper//base">基 础</a></span><span><a aria-current="page" class="active" href="/issues-helper//advanced">进 阶</a></span><span><a href="/issues-helper//changelog">更新日志</a></span><span><a target="_blank" rel="noopener noreferrer" href="https://issues-helper.gitee.io">国内镜像<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></span><span><a target="_blank" rel="noopener noreferrer" href="https://github.com/actions-cool/issues-helper">GitHub<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></span><div class="__dumi-default-navbar-tool"><div class="__dumi-default-locale-select" data-locale-count="2"><a href="/issues-helper//en-US/advanced">English</a></div><div class="__dumi-default-dark"><div class="__dumi-default-dark-switch "></div></div></div></nav></div><div class="__dumi-default-menu" data-mode="site"><div class="__dumi-default-menu-inner"><div class="__dumi-default-menu-header"><a class="__dumi-default-menu-logo" style="background-image:url('https://avatars1.githubusercontent.com/u/73879334?s=200&v=4')" href="/issues-helper//"></a><h1>Issues Helper</h1><p></p></div><div class="__dumi-default-menu-mobile-area"><ul class="__dumi-default-menu-nav-list"><li><a href="/issues-helper//guide">指 南</a></li><li><a href="/issues-helper//base">基 础</a></li><li><a aria-current="page" class="active" href="/issues-helper//advanced">进 阶</a></li><li><a href="/issues-helper//changelog">更新日志</a></li><li><a target="_blank" rel="noopener noreferrer" href="https://issues-helper.gitee.io">国内镜像<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></li><li><a target="_blank" rel="noopener noreferrer" href="https://github.com/actions-cool/issues-helper">GitHub<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></li></ul><div class="__dumi-default-locale-select" data-locale-count="2"><a href="/issues-helper//en-US/advanced">English</a></div><div class="__dumi-default-dark"><div class="__dumi-default-dark-switch "><button title="Dark theme" class="__dumi-default-dark-moon "><svg viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="3854" width="22" height="22"><path d="M991.816611 674.909091a69.166545 69.166545 0 0 0-51.665455-23.272727 70.795636 70.795636 0 0 0-27.438545 5.585454A415.674182 415.674182 0 0 1 754.993338 698.181818c-209.594182 0-393.472-184.785455-393.472-395.636363 0-52.363636 38.539636-119.621818 69.515637-173.614546 4.887273-8.610909 9.634909-16.756364 14.103272-24.901818A69.818182 69.818182 0 0 0 384.631156 0a70.842182 70.842182 0 0 0-27.438545 5.585455C161.678429 90.298182 14.362065 307.898182 14.362065 512c0 282.298182 238.824727 512 532.38691 512a522.286545 522.286545 0 0 0 453.957818-268.334545A69.818182 69.818182 0 0 0 991.816611 674.909091zM546.679156 954.181818c-248.785455 0-462.941091-192-462.941091-442.181818 0-186.647273 140.637091-372.829091 300.939637-442.181818-36.817455 65.629091-92.578909 151.970909-92.578909 232.727273 0 250.181818 214.109091 465.454545 462.917818 465.454545a488.331636 488.331636 0 0 0 185.181091-46.545455 453.003636 453.003636 0 0 1-393.565091 232.727273z m103.656728-669.323636l-14.266182 83.781818a34.909091 34.909091 0 0 0 50.362182 36.770909l74.775272-39.563636 74.752 39.563636a36.142545 36.142545 0 0 0 16.174546 3.956364 34.909091 34.909091 0 0 0 34.210909-40.727273l-14.289455-83.781818 60.509091-59.345455a35.025455 35.025455 0 0 0-19.223272-59.578182l-83.61891-12.101818-37.376-76.101818a34.56 34.56 0 0 0-62.254545 0l-37.376 76.101818-83.618909 12.101818a34.909091 34.909091 0 0 0-19.246546 59.578182z m70.423272-64.698182a34.280727 34.280727 0 0 0 26.135273-19.083636l14.312727-29.090909 14.336 29.090909a34.257455 34.257455 0 0 0 26.135273 19.083636l32.046546 4.887273-23.272728 22.574545a35.234909 35.234909 0 0 0-10.007272 30.952727l5.46909 32.116364-28.625454-15.127273a34.490182 34.490182 0 0 0-32.302546 0l-28.695272 15.127273 5.469091-32.116364a35.141818 35.141818 0 0 0-9.984-30.952727l-23.272728-22.574545z" p-id="3855"></path></svg></button><button title="Light theme" class="__dumi-default-dark-sun "><svg viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="4026" width="22" height="22"><path d="M915.2 476.16h-43.968c-24.704 0-44.736 16-44.736 35.84s20.032 35.904 44.736 35.904H915.2c24.768 0 44.8-16.064 44.8-35.904s-20.032-35.84-44.8-35.84zM512 265.6c-136.704 0-246.464 109.824-246.464 246.4 0 136.704 109.76 246.464 246.464 246.464S758.4 648.704 758.4 512c0-136.576-109.696-246.4-246.4-246.4z m0 425.6c-99.008 0-179.2-80.128-179.2-179.2 0-98.944 80.192-179.2 179.2-179.2S691.2 413.056 691.2 512c0 99.072-80.192 179.2-179.2 179.2zM197.44 512c0-19.84-19.136-35.84-43.904-35.84H108.8c-24.768 0-44.8 16-44.8 35.84s20.032 35.904 44.8 35.904h44.736c24.768 0 43.904-16.064 43.904-35.904zM512 198.464c19.776 0 35.84-20.032 35.84-44.8v-44.8C547.84 84.032 531.84 64 512 64s-35.904 20.032-35.904 44.8v44.8c0 24.768 16.128 44.864 35.904 44.864z m0 627.136c-19.776 0-35.904 20.032-35.904 44.8v44.736C476.096 940.032 492.16 960 512 960s35.84-20.032 35.84-44.8v-44.736c0-24.768-16.064-44.864-35.84-44.864z m329.92-592.832c17.472-17.536 20.288-43.072 6.4-57.024-14.016-14.016-39.488-11.2-57.024 6.336-4.736 4.864-26.496 26.496-31.36 31.36-17.472 17.472-20.288 43.008-6.336 57.024 13.952 14.016 39.488 11.2 57.024-6.336 4.8-4.864 26.496-26.56 31.296-31.36zM213.376 759.936c-4.864 4.8-26.56 26.624-31.36 31.36-17.472 17.472-20.288 42.944-6.4 56.96 14.016 13.952 39.552 11.2 57.024-6.336 4.8-4.736 26.56-26.496 31.36-31.36 17.472-17.472 20.288-43.008 6.336-56.96-14.016-13.952-39.552-11.072-56.96 6.336z m19.328-577.92c-17.536-17.536-43.008-20.352-57.024-6.336-14.08 14.016-11.136 39.488 6.336 57.024 4.864 4.864 26.496 26.56 31.36 31.424 17.536 17.408 43.008 20.288 56.96 6.336 14.016-14.016 11.264-39.488-6.336-57.024-4.736-4.864-26.496-26.56-31.296-31.424z m527.168 628.608c4.864 4.864 26.624 26.624 31.36 31.424 17.536 17.408 43.072 20.224 57.088 6.336 13.952-14.016 11.072-39.552-6.4-57.024-4.864-4.8-26.56-26.496-31.36-31.36-17.472-17.408-43.072-20.288-57.024-6.336-13.952 14.016-11.008 39.488 6.336 56.96z" p-id="4027"></path></svg></button><button title="Default to system" class="__dumi-default-dark-auto "><svg viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="11002" width="22" height="22"><path d="M127.658667 492.885333c0-51.882667 10.24-101.717333 30.378666-149.162666s47.786667-88.064 81.92-122.538667 75.093333-61.781333 122.538667-81.92 96.938667-30.378667 149.162667-30.378667 101.717333 10.24 149.162666 30.378667 88.405333 47.786667 122.88 81.92 61.781333 75.093333 81.92 122.538667 30.378667 96.938667 30.378667 149.162666-10.24 101.717333-30.378667 149.162667-47.786667 88.405333-81.92 122.88-75.093333 61.781333-122.88 81.92-97.28 30.378667-149.162666 30.378667-101.717333-10.24-149.162667-30.378667-88.064-47.786667-122.538667-81.92-61.781333-75.093333-81.92-122.88-30.378667-96.938667-30.378666-149.162667z m329.045333 0c0 130.048 13.994667 244.394667 41.984 343.381334h12.970667c46.762667 0 91.136-9.216 133.461333-27.306667s78.848-42.666667 109.568-73.386667 54.954667-67.242667 73.386667-109.568 27.306667-86.698667 27.306666-133.461333c0-46.421333-9.216-90.794667-27.306666-133.12s-42.666667-78.848-73.386667-109.568-67.242667-54.954667-109.568-73.386667-86.698667-27.306667-133.461333-27.306666h-11.605334c-28.672 123.562667-43.349333 237.909333-43.349333 343.722666z" p-id="11003"></path></svg></button></div></div></div><ul class="__dumi-default-menu-list"><li><a aria-current="page" class="active" href="/issues-helper//advanced">🌟 进 阶</a><ul role="slug-list"><li title="check-inactive" data-depth="2"><a href="/issues-helper//advanced#check-inactive"><span>check-inactive</span></a></li><li title="check-issue" data-depth="2"><a href="/issues-helper//advanced#check-issue"><span>check-issue</span></a></li><li title="close-issues" data-depth="2"><a href="/issues-helper//advanced#close-issues"><span>close-issues</span></a></li><li title="find-comments" data-depth="2"><a href="/issues-helper//advanced#find-comments"><span>find-comments</span></a></li><li title="lock-issues" data-depth="2"><a href="/issues-helper//advanced#lock-issues"><span>lock-issues</span></a></li><li title="month-statistics" data-depth="2"><a href="/issues-helper//advanced#month-statistics"><span>month-statistics</span></a></li></ul></li></ul></div></div><div class="__dumi-default-layout-content"><div class="markdown"><h1 id="-进-阶"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#-进-阶"><span class="icon icon-link"></span></a>🌟 进 阶</h1><p>进阶用法不建议 actions 多个一次同时使用。</p><h2 id="check-inactive"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#check-inactive"><span class="icon icon-link"></span></a><code>check-inactive</code></h2><p>每月 1 号 UTC 0 时，对所有 30 天以上未活跃的 issues 增加 <code>inactive</code> 标签。</p><div class="__dumi-default-code-block"><pre class="prism-code language-yml"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> Check inactive</span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">on</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">schedule</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">cron</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">"0 0 1 * *"</span><span class="token plain"></span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">jobs</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">check-inactive</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">runs-on</span><span class="token punctuation">:</span><span class="token plain"> ubuntu</span><span class="token punctuation">-</span><span class="token plain">latest</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">steps</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> check</span><span class="token punctuation">-</span><span class="token plain">inactive</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">uses</span><span class="token punctuation">:</span><span class="token plain"> actions</span><span class="token punctuation">-</span><span class="token plain">cool/issues</span><span class="token punctuation">-</span><span class="token plain">helper@v2</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">with</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">actions</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'check-inactive'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">token</span><span class="token punctuation">:</span><span class="token plain"> $</span><span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token plain"> secrets.GITHUB_TOKEN </span><span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">inactive-day</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token number">30</span></div></pre></div><table><thead><tr><th>参数</th><th>描述</th><th>类型</th><th>必填</th></tr></thead><tbody><tr><td>actions</td><td>操作类型</td><td>string</td><td>✔</td></tr><tr><td>token</td><td><a href="/issues-helper//guide/ref#-token-%E8%AF%B4%E6%98%8E">token 说明</a></td><td>string</td><td>✔</td></tr><tr><td>body</td><td>操作 issue 时，可进行评论。不填时，不评论</td><td>string</td><td>✖</td></tr><tr><td>contents</td><td>为该评论增加 <a href="/issues-helper//guide/ref#-reactions-%E7%B1%BB%E5%9E%8B">reaction</a></td><td>string</td><td>✖</td></tr><tr><td>labels</td><td>标签筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-state</td><td>状态筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-assignee</td><td>指定人筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-creator</td><td>创建人筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-mentioned</td><td>提及人筛选</td><td>string</td><td>✖</td></tr><tr><td>body-includes</td><td>包含内容筛选</td><td>string</td><td>✖</td></tr><tr><td>title-includes</td><td>包含标题筛选</td><td>string</td><td>✖</td></tr><tr><td>inactive-day</td><td>非活跃天数筛选</td><td>number</td><td>✖</td></tr><tr><td>inactive-label</td><td>新增标签名称</td><td>string</td><td>✖</td></tr><tr><td>exclude-labels</td><td>排除标签筛选</td><td>string</td><td>✖</td></tr></tbody></table><ul><li><code>labels</code>：为多个时，会查询同时拥有多个。不填时，会查询所有</li><li><code>issue-state</code>：默认为 <code>all</code>。可选值 <code>open</code> <code>closed</code>，非这 2 项时，均为 <code>all</code></li><li><code>issue-assignee</code>：不支持多人。不填或输入 * 时，查询所有。输入 <code>none</code> 会查询未添加指定人的 issues</li><li><code>inactive-day</code>：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有</li><li><code>inactive-label</code>：默认为 <code>inactive</code>，可自定义其他。当项目未包含该 label 时，会自动新建</li></ul><h2 id="check-issue"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#check-issue"><span class="icon icon-link"></span></a><code>check-issue</code></h2><p>根据传入的参数和 <code>issue-number</code> 来检查该 issue 是否满足条件，返回一个布尔值。</p><p>下面的例子效果是：当 issue 新开时，校验当前 issue 指定人是否包含 <code>x1</code> 或者 <code>x2</code>，满足一个指定人即可校验通过，同时校验标题是否满足条件，<a href="/issues-helper//guide/ref#-includes-%E6%A0%A1%E9%AA%8C%E8%A7%84%E5%88%99">校验规则</a>。</p><div class="__dumi-default-code-block"><pre class="prism-code language-yml"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> Check Issue</span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">on</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">issues</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">types</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token punctuation">[</span><span class="token plain">edited</span><span class="token punctuation">]</span><span class="token plain"></span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">jobs</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">check-issue</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">runs-on</span><span class="token punctuation">:</span><span class="token plain"> ubuntu</span><span class="token punctuation">-</span><span class="token plain">latest</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">steps</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> check</span><span class="token punctuation">-</span><span class="token plain">issue</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">uses</span><span class="token punctuation">:</span><span class="token plain"> actions</span><span class="token punctuation">-</span><span class="token plain">cool/issues</span><span class="token punctuation">-</span><span class="token plain">helper@v2</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">with</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">actions</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'check-issue'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">token</span><span class="token punctuation">:</span><span class="token plain"> $</span><span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token plain"> secrets.GITHUB_TOKEN </span><span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">issue-number</span><span class="token punctuation">:</span><span class="token plain"> $</span><span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token plain"> github.event.issue.number </span><span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">assignee-includes</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'x1,x2'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">title-includes</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'x1,x2/y1,y2'</span></div></pre></div><table><thead><tr><th>参数</th><th>描述</th><th>类型</th><th>必填</th></tr></thead><tbody><tr><td>actions</td><td>操作类型</td><td>string</td><td>✔</td></tr><tr><td>token</td><td><a href="/issues-helper//guide/ref#-token-%E8%AF%B4%E6%98%8E">token 说明</a></td><td>string</td><td>✔</td></tr><tr><td>issue-number</td><td>指定的 issue，当不传时会从触发事件中获取</td><td>number</td><td>✖</td></tr><tr><td>assignee-includes</td><td>是否包含指定人</td><td>string</td><td>✖</td></tr><tr><td>title-includes</td><td>标题包含校验</td><td>string</td><td>✖</td></tr><tr><td>title-excludes</td><td>检测标题移除默认 title 后是否为空</td><td>string</td><td>✖</td></tr><tr><td>body-includes</td><td>内容包含校验</td><td>string</td><td>✖</td></tr></tbody></table><ul><li><code>title-includes</code> <code>body-includes</code> 支持格式 <code>x1,x2</code> 或者 <code>x1,x2/y1,y2</code>。只支持两个层级</li><li>返回 <code>check-result</code>，由于 yml 原因，判断条件为 <code>if: steps.xxid.outputs.check-result == 'true'</code></li></ul><h2 id="close-issues"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#close-issues"><span class="icon icon-link"></span></a><code>close-issues</code></h2><p>每 7 天 UTC 0 时，关闭已填加 <code>need info</code> label 且 7 天以上未活跃的 issues。</p><div class="__dumi-default-code-block"><pre class="prism-code language-yml"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> Check need info</span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">on</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">schedule</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">cron</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">"0 0 */7 * *"</span><span class="token plain"></span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">jobs</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">check-need-info</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">runs-on</span><span class="token punctuation">:</span><span class="token plain"> ubuntu</span><span class="token punctuation">-</span><span class="token plain">latest</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">steps</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> close</span><span class="token punctuation">-</span><span class="token plain">issues</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">uses</span><span class="token punctuation">:</span><span class="token plain"> actions</span><span class="token punctuation">-</span><span class="token plain">cool/issues</span><span class="token punctuation">-</span><span class="token plain">helper@v2</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">with</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">actions</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'close-issues'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">token</span><span class="token punctuation">:</span><span class="token plain"> $</span><span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token plain"> secrets.GITHUB_TOKEN </span><span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">labels</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'need info'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">inactive-day</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token number">7</span></div></pre></div><table><thead><tr><th>参数</th><th>描述</th><th>类型</th><th>必填</th></tr></thead><tbody><tr><td>actions</td><td>操作类型</td><td>string</td><td>✔</td></tr><tr><td>token</td><td><a href="/issues-helper//guide/ref#-token-%E8%AF%B4%E6%98%8E">token 说明</a></td><td>string</td><td>✔</td></tr><tr><td>body</td><td>操作 issue 时，可进行评论。不填时，不评论</td><td>string</td><td>✖</td></tr><tr><td>contents</td><td>为该评论增加 <a href="/issues-helper//guide/ref#-reactions-%E7%B1%BB%E5%9E%8B">reaction</a></td><td>string</td><td>✖</td></tr><tr><td>labels</td><td>标签筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-assignee</td><td>指定人筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-creator</td><td>创建人筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-mentioned</td><td>提及人筛选</td><td>string</td><td>✖</td></tr><tr><td>body-includes</td><td>包含内容筛选</td><td>string</td><td>✖</td></tr><tr><td>title-includes</td><td>包含标题筛选</td><td>string</td><td>✖</td></tr><tr><td>inactive-day</td><td>非活跃天数筛选</td><td>number</td><td>✖</td></tr><tr><td>exclude-labels</td><td>排除标签筛选</td><td>string</td><td>✖</td></tr></tbody></table><ul><li><code>labels</code>：为多个时，会查询同时拥有多个。不填时，会查询所有</li><li><code>issue-assignee</code>：不支持多人。不填或输入 * 时，查询所有。输入 <code>none</code> 会查询未添加指定人的 issues</li><li><code>inactive-day</code>：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有</li></ul><h2 id="find-comments"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#find-comments"><span class="icon icon-link"></span></a><code>find-comments</code></h2><p>查找当前仓库 1 号 issue 中，创建者是 k ，内容包含 <code>this</code> 的评论列表。</p><div class="__dumi-default-code-block"><pre class="prism-code language-yml"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> Find comments</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">uses</span><span class="token punctuation">:</span><span class="token plain"> actions</span><span class="token punctuation">-</span><span class="token plain">cool/issues</span><span class="token punctuation">-</span><span class="token plain">helper@v2</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">with</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">actions</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'find-comments'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">token</span><span class="token punctuation">:</span><span class="token plain"> $</span><span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token plain"> secrets.GITHUB_TOKEN </span><span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">issue-number</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">comment-auth</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'k'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">body-includes</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'this'</span></div></pre></div><table><thead><tr><th>参数</th><th>描述</th><th>类型</th><th>必填</th></tr></thead><tbody><tr><td>actions</td><td>操作类型</td><td>string</td><td>✔</td></tr><tr><td>token</td><td><a href="/issues-helper//guide/ref#-token-%E8%AF%B4%E6%98%8E">token 说明</a></td><td>string</td><td>✔</td></tr><tr><td>issue-number</td><td>指定的 issue，当不传时会从触发事件中获取</td><td>number</td><td>✖</td></tr><tr><td>comment-auth</td><td>评论创建者，不填时会查询所有</td><td>string</td><td>✖</td></tr><tr><td>body-includes</td><td>评论内容包含过滤，不填时无校验</td><td>string</td><td>✖</td></tr><tr><td>direction</td><td>返回 <code>comments</code> 排序</td><td>string</td><td>✖</td></tr></tbody></table><ul><li>返回 <code>comments</code>，格式如下：</li></ul><div class="__dumi-default-code-block"><pre class="prism-code language-js"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token punctuation">[</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">{</span><span class="token plain">id</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token punctuation">,</span><span class="token plain"> auth</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">'x'</span><span class="token punctuation">,</span><span class="token plain"> body</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">'xxx'</span><span class="token punctuation">,</span><span class="token plain"> created</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">''</span><span class="token punctuation">,</span><span class="token plain"> updated</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">''</span><span class="token punctuation">}</span><span class="token punctuation">,</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">{</span><span class="token plain">id</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">2</span><span class="token punctuation">,</span><span class="token plain"> auth</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">'x'</span><span class="token punctuation">,</span><span class="token plain"> body</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">'xxx'</span><span class="token punctuation">,</span><span class="token plain"> created</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">''</span><span class="token punctuation">,</span><span class="token plain"> updated</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string">''</span><span class="token punctuation">}</span><span class="token punctuation">,</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"></span><span class="token punctuation">]</span></div></pre></div><ul><li><code>direction</code> 默认为升序，只有设置 <code>desc</code> 时，会返回降序</li><li>返回数组中 <code>created</code> <code>updated</code>，由所处环境决定，会是 UTC +0</li></ul><h2 id="lock-issues"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#lock-issues"><span class="icon icon-link"></span></a><code>lock-issues</code></h2><p>每 3 个月 1 号 UTC 0 时，锁定已填加 <code>inactive</code> label 且 128 天以上未活跃的所有 issues。</p><div class="__dumi-default-code-block"><pre class="prism-code language-yml"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> Lock inactive issues</span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">on</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">schedule</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">cron</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">"0 0 1 */3 *"</span><span class="token plain"></span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain"></span><span class="token key atrule">jobs</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">lock-issues</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">runs-on</span><span class="token punctuation">:</span><span class="token plain"> ubuntu</span><span class="token punctuation">-</span><span class="token plain">latest</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">steps</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token punctuation">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation">:</span><span class="token plain"> lock</span><span class="token punctuation">-</span><span class="token plain">issues</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">uses</span><span class="token punctuation">:</span><span class="token plain"> actions</span><span class="token punctuation">-</span><span class="token plain">cool/issues</span><span class="token punctuation">-</span><span class="token plain">helper@v2</span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">with</span><span class="token punctuation">:</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">actions</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'lock-issues'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">token</span><span class="token punctuation">:</span><span class="token plain"> $</span><span class="token punctuation">{</span><span class="token punctuation">{</span><span class="token plain"> secrets.GITHUB_TOKEN </span><span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">labels</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token string">'inactive'</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"> </span><span class="token key atrule">inactive-day</span><span class="token punctuation">:</span><span class="token plain"> </span><span class="token number">128</span></div></pre></div><table><thead><tr><th>参数</th><th>描述</th><th>类型</th><th>必填</th></tr></thead><tbody><tr><td>actions</td><td>操作类型</td><td>string</td><td>✔</td></tr><tr><td>token</td><td><a href="/issues-helper//guide/ref#-token-%E8%AF%B4%E6%98%8E">token 说明</a></td><td>string</td><td>✔</td></tr><tr><td>body</td><td>操作 issue 时，可进行评论。不填时，不评论</td><td>string</td><td>✖</td></tr><tr><td>contents</td><td>为该评论增加 <a href="/issues-helper//guide/ref#-reactions-%E7%B1%BB%E5%9E%8B">reaction</a></td><td>string</td><td>✖</td></tr><tr><td>labels</td><td>标签筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-state</td><td>状态筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-assignee</td><td>指定人筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-creator</td><td>创建人筛选</td><td>string</td><td>✖</td></tr><tr><td>issue-mentioned</td><td>提及人筛选</td><td>string</td><td>✖</td></tr><tr><td>body-includes</td><td>包含内容筛选</td><td>string</td><td>✖</td></tr><tr><td>title-includes</td><td>包含标题筛选</td><td>string</td><td>✖</td></tr><tr><td>inactive-day</td><td>非活跃天数筛选</td><td>number</td><td>✖</td></tr><tr><td>lock-reason</td><td>锁定 issue 的原因</td><td>string</td><td>✖</td></tr><tr><td>exclude-labels</td><td>排除标签筛选</td><td>string</td><td>✖</td></tr></tbody></table><ul><li><code>labels</code>：为多个时，会查询同时拥有多个。不填时，会查询所有</li><li><code>issue-state</code>：默认为 <code>all</code>。可选值 <code>open</code> <code>closed</code>，非这 2 项时，均为 <code>all</code></li><li><code>issue-assignee</code>：不支持多人。不填或输入 * 时，查询所有。输入 <code>none</code> 会查询未添加指定人的 issues</li><li><code>inactive-day</code>：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有</li></ul><h2 id="month-statistics"><a aria-hidden="true" tabindex="-1" href="/issues-helper//advanced#month-statistics"><span class="icon icon-link"></span></a><code>month-statistics</code></h2><p>每月 1 号 1 时，生成一个 issue 上月统计。</p><div class="__dumi-default-code-block"><pre class="prism-code language-unknown"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token plain">name: Issue Month Statistics</span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain">on:</span></div><div class="token-line"><span class="token plain"> schedule:</span></div><div class="token-line"><span class="token plain"> - cron: "0 1 1 * *"</span></div><div class="token-line"><span class="token plain">
|
||
</span></div><div class="token-line"><span class="token plain">jobs:</span></div><div class="token-line"><span class="token plain"> month-statistics:</span></div><div class="token-line"><span class="token plain"> runs-on: ubuntu-latest</span></div><div class="token-line"><span class="token plain"> steps:</span></div><div class="token-line"><span class="token plain"> - name: month-statistics</span></div><div class="token-line"><span class="token plain"> uses: actions-cool/issues-helper@v2</span></div><div class="token-line"><span class="token plain"> with:</span></div><div class="token-line"><span class="token plain"> actions: 'month-statistics'</span></div><div class="token-line"><span class="token plain"> token: ${{ secrets.GITHUB_TOKEN }}</span></div><div class="token-line"><span class="token plain"> count-lables: 'true'</span></div></pre></div><table><thead><tr><th>参数</th><th>描述</th><th>类型</th><th>必填</th></tr></thead><tbody><tr><td>actions</td><td>操作类型</td><td>string</td><td>✔</td></tr><tr><td>token</td><td><a href="/issues-helper//guide/ref#-token-%E8%AF%B4%E6%98%8E">token 说明</a></td><td>string</td><td>✔</td></tr><tr><td>labels</td><td>为新增 issue 添加 labels</td><td>string</td><td>✖</td></tr><tr><td>assignees</td><td>为新增 issue 添加 assignees</td><td>string</td><td>✖</td></tr><tr><td>count-lables</td><td>新增 issue 是否统计 labels</td><td>string</td><td>✖</td></tr><tr><td>count-comments</td><td>新增 issue 是否统计 comments</td><td>string</td><td>✖</td></tr></tbody></table><ul><li>新增 <code>issue</code> 的标题默认为 <code>[当前仓库] Month Statistics: 年-月</code></li><li><code>count-lables</code>：可设置 <code>'true'</code>，增加 labels 统计</li><li><code>count-comments</code>：可设置 <code>'true'</code>，增加 comments 统计</li></ul><p>如下所示：</p><p><img src="/issues-helper/static/month.a512c8ae.png" alt=""/></p></div><div class="__dumi-default-layout-footer-meta"><a target="_blank" rel="noopener noreferrer" href="https://github.com/actions-cool/issues-helper/edit/main/docs/advanced.md">在 GitHub 上编辑此页<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a><span data-updated-text="最后更新时间：">9/7/2021 01:24:57</span></div></div></div></div>
|
||
<script>
|
||
window.g_useSSR = true;
|
||
window.g_initialProps = {};
|
||
</script>
|
||
|
||
<script src="/issues-helper/umi.d6c9b1dd.js"></script>
|
||
</body>
|
||
</html>
|