diff --git a/README.md b/README.md index 2beb5bb..372741d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Create comment on pull request, if exists update that comment. ## Usage: +### Basic + ```yaml uses: marocchino/sticky-pull-request-comment@v1 with: @@ -12,6 +14,82 @@ with: Release ${{ github.sha }} to ``` +### Keep more than one comment + +In some cases, different actions may require different comments. The header allows you to maintain comments independently. + +```yaml +release: + ... + - uses: marocchino/sticky-pull-request-comment@v1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + header: release + message: | + Release ${{ github.sha }} to + +test: + ... + - name: Run Test + id: test + run: | + OUTPUT=$(rake test) + OUTPUT="${OUTPUT//'%'/'%25'}​【7,6 m】" + OUTPUT="${OUTPUT//$'\n'/'%0A'}" + OUTPUT="${OUTPUT//$'\r'/'%0D'}" + echo "::set-output name=result::$OUTPUT" + - uses: marocchino/sticky-pull-request-comment@v1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + header: test + message: | + ``` + ${{ steps.test.outputs.result }} + ``` +``` + +### Append after comment every time it runs + +```yaml +test: + ... + - name: Run Test + id: test + run: | + OUTPUT=$(rake test) + OUTPUT="${OUTPUT//'%'/'%25'}​【7,6 m】" + OUTPUT="${OUTPUT//$'\n'/'%0A'}" + OUTPUT="${OUTPUT//$'\r'/'%0D'}" + echo "::set-output name=result::$OUTPUT" + - uses: marocchino/sticky-pull-request-comment@v1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + append: true + message: | + Test with ${{ github.sha }}. + ``` + ${{ steps.test.outputs.result }} + ``` +``` + +### Comment from push + +If for some reason, triggering on pr is not possible, you can use push. + +```yaml +- uses: jwalton/gh-find-current-pr@v1 +id: finder +with: + github-token: ${{ secrets.GITHUB_TOKEN }} +- uses: marocchino/sticky-pull-request-comment@v1 +with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + number: ${{ steps.finder.outputs.pr }} + message: | + Test ${{ github.sha }} is successfully ended. + This is message from push. +``` + ## Development Install the dependencies