mirror of
https://github.com/marocchino/sticky-pull-request-comment.git
synced 2025-12-14 20:41:15 +00:00
π Update README
This commit is contained in:
parent
87bbf557c1
commit
68f49e0cab
1 changed files with 29 additions and 16 deletions
45
README.md
45
README.md
|
|
@ -7,6 +7,13 @@ This library runs with GitHub Actions. If you feel that the example grammar belo
|
||||||
|
|
||||||
### Basic
|
### Basic
|
||||||
|
|
||||||
|
You need to add permissions for this tool.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
```
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
uses: marocchino/sticky-pull-request-comment@v2
|
uses: marocchino/sticky-pull-request-comment@v2
|
||||||
with:
|
with:
|
||||||
|
|
@ -30,19 +37,17 @@ release:
|
||||||
test:
|
test:
|
||||||
...
|
...
|
||||||
- name: Run Test
|
- name: Run Test
|
||||||
id: test
|
|
||||||
run: |
|
run: |
|
||||||
OUTPUT=$(rake test)
|
EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
|
||||||
OUTPUT="${OUTPUT//'%'/'%25'}βγ7,6 mγ"
|
echo "test_result<<$EOF" >> "$GITHUB_ENV"
|
||||||
OUTPUT="${OUTPUT//$'\n'/'%0A'}"
|
rake test >> "$GITHUB_ENV"
|
||||||
OUTPUT="${OUTPUT//$'\r'/'%0D'}"
|
echo "$EOF" >> "$GITHUB_ENV"
|
||||||
echo "result=$OUTPUT" >> $GITHUB_OUTPUT
|
|
||||||
- uses: marocchino/sticky-pull-request-comment@v2
|
- uses: marocchino/sticky-pull-request-comment@v2
|
||||||
with:
|
with:
|
||||||
header: test
|
header: test
|
||||||
message: |
|
message: |
|
||||||
```
|
```
|
||||||
${{ steps.test.outputs.result }}
|
${{ env.test_result }}
|
||||||
```
|
```
|
||||||
````
|
````
|
||||||
|
|
||||||
|
|
@ -52,20 +57,18 @@ test:
|
||||||
test:
|
test:
|
||||||
...
|
...
|
||||||
- name: Run Test
|
- name: Run Test
|
||||||
id: test
|
|
||||||
run: |
|
run: |
|
||||||
OUTPUT=$(rake test)
|
EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
|
||||||
OUTPUT="${OUTPUT//'%'/'%25'}βγ7,6 mγ"
|
echo "test_result<<$EOF" >> "$GITHUB_ENV"
|
||||||
OUTPUT="${OUTPUT//$'\n'/'%0A'}"
|
rake test >> "$GITHUB_ENV"
|
||||||
OUTPUT="${OUTPUT//$'\r'/'%0D'}"
|
echo "$EOF" >> "$GITHUB_ENV"
|
||||||
echo "result=$OUTPUT" >> $GITHUB_OUTPUT
|
|
||||||
- uses: marocchino/sticky-pull-request-comment@v2
|
- uses: marocchino/sticky-pull-request-comment@v2
|
||||||
with:
|
with:
|
||||||
append: true
|
append: true
|
||||||
message: |
|
message: |
|
||||||
Test with ${{ github.sha }}.
|
Test with ${{ github.sha }}.
|
||||||
```
|
```
|
||||||
${{ steps.test.outputs.result }}
|
${{ env.test_result }}
|
||||||
```
|
```
|
||||||
````
|
````
|
||||||
|
|
||||||
|
|
@ -134,8 +137,18 @@ with:
|
||||||
|
|
||||||
### Error: Resource not accessible by integration
|
### Error: Resource not accessible by integration
|
||||||
|
|
||||||
This message means the requester does not have enough permission. If `secrets.GITHUB_TOKEN`
|
This tool requires write permission, and that message means the requester does not have enough permission.
|
||||||
is explicitly passed, this problem can be solved by just removing it.
|
Recently, GitHub sets permissions conservatively for newly created repositories. If it's a newly created repository, check your Settings > Actions > General > Workflow permissions, and make sure to enable read and write permissions.
|
||||||
|
|
||||||
|
Then, you can specify permissions for the job like this:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
```
|
||||||
|
|
||||||
|
For more detailed information about permissions, you can read from the link below:
|
||||||
|
<https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs>
|
||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
|
|
|
||||||
Loadingβ¦
Reference in a new issue