mirror of
https://github.com/peter-evans/create-or-update-comment.git
synced 2025-01-31 19:56:39 +08:00
Update readme
This commit is contained in:
parent
ac60f19020
commit
90e17f05b7
1
.github/comment-template.md
vendored
1
.github/comment-template.md
vendored
@ -1,3 +1,2 @@
|
|||||||
This is a test comment template
|
This is a test comment template
|
||||||
|
|
||||||
Render template variables such as {{ .foo }} and {{ .bar }}.
|
Render template variables such as {{ .foo }} and {{ .bar }}.
|
||||||
|
26
README.md
26
README.md
@ -176,6 +176,32 @@ The content must be [escaped to preserve newlines](https://github.community/t/se
|
|||||||
body: ${{ steps.get-comment-body.outputs.body }}
|
body: ${{ steps.get-comment-body.outputs.body }}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Using a markdown template
|
||||||
|
|
||||||
|
In this example, a markdown template file is added to the repository at `.github/comment-template.md` with the following content.
|
||||||
|
```
|
||||||
|
This is a test comment template
|
||||||
|
Render template variables such as {{ .foo }} and {{ .bar }}.
|
||||||
|
```
|
||||||
|
|
||||||
|
The template is rendered using the [render-template](https://github.com/chuhlomin/render-template) action and the result is used to create the comment.
|
||||||
|
```yml
|
||||||
|
- name: Render template
|
||||||
|
id: template
|
||||||
|
uses: chuhlomin/render-template@v1.2
|
||||||
|
with:
|
||||||
|
template: .github/comment-template.md
|
||||||
|
vars: |
|
||||||
|
foo: this
|
||||||
|
bar: that
|
||||||
|
|
||||||
|
- name: Create comment
|
||||||
|
uses: peter-evans/create-or-update-comment@v1
|
||||||
|
with:
|
||||||
|
issue-number: 1
|
||||||
|
body: ${{ steps.template.outputs.result }}
|
||||||
|
```
|
||||||
|
|
||||||
### Accessing issues and comments in other repositories
|
### Accessing issues and comments in other repositories
|
||||||
|
|
||||||
You can create and update comments in another repository by using a [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) instead of `GITHUB_TOKEN`.
|
You can create and update comments in another repository by using a [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) instead of `GITHUB_TOKEN`.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user