Skip to content

Commit 4a69ff0

Browse files
authored
docs: add Work with Issue Template (#332)
#326
1 parent 9a5d08a commit 4a69ff0

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ This Action was submitted to the [GitHub Actions Hackathon] and featured by GitH
3333
- [Set a Path to Action Setting File](#set-a-path-to-action-setting-file)
3434
- [Set a Personal Access Token](#set-a-personal-access-token)
3535
- [Enable Debug Mode](#enable-debug-mode)
36+
- [Work with Issue Template](#work-with-issue-template)
3637
- [Work with Other Auto Label Actions](#work-with-other-auto-label-actions)
3738
- [Examples](#examples)
3839
- [Comment and Close Invalid Format Issue or Pull Request](#comment-and-close-invalid-format-issue-or-pull-request)
@@ -254,6 +255,33 @@ Default is `${{ github.token }}`
254255

255256

256257

258+
## Work with Issue Template
259+
260+
Here is a proposal issue template: [.github/ISSUE_TEMPLATE/proposal.md](https://github.com/peaceiris/actions-label-commenter/blob/main/.github/ISSUE_TEMPLATE/proposal.md)
261+
262+
```yaml
263+
---
264+
name: Proposal
265+
about: Suggest an idea for this project
266+
title: 'proposal: This is a sample title'
267+
labels: proposal
268+
assignees: peaceiris
269+
---
270+
271+
Issue body here...
272+
```
273+
274+
Scenario:
275+
276+
1. When a user opens an issue with the proposal template, the proposal label will be added automatically.
277+
1. This action can detect that `labeled` event and create a template comment of proposal.
278+
279+
<div align="right">
280+
<a href="#table-of-contents">Back to TOC ☝️</a>
281+
</div>
282+
283+
284+
257285
## Work with Other Auto Label Actions
258286

259287
> [Authenticating with the GITHUB_TOKEN - GitHub Docs](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#using-the-github_token-in-a-workflow)

0 commit comments

Comments
 (0)