Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wesleyscholl/discussion-auto-responder
Autorespond to New Discussions with a Preset Comment or Welcome Message
https://github.com/wesleyscholl/discussion-auto-responder
actions automated automation comment comment-system comments discussion discussion-forum github github-actions github-workflows workflow
Last synced: 3 days ago
JSON representation
Autorespond to New Discussions with a Preset Comment or Welcome Message
- Host: GitHub
- URL: https://github.com/wesleyscholl/discussion-auto-responder
- Owner: wesleyscholl
- License: mit
- Created: 2023-09-18T13:18:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-25T01:15:50.000Z (about 1 year ago)
- Last Synced: 2023-09-25T04:27:26.843Z (about 1 year ago)
- Topics: actions, automated, automation, comment, comment-system, comments, discussion, discussion-forum, github, github-actions, github-workflows, workflow
- Language: TypeScript
- Homepage: https://github.com/wesleyscholl/discussion-auto-responder
- Size: 4.74 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discussion Autoresponder 💬⏳📝
Autorespond to New Discussions with a Preset Comment or Welcome Message
[](https://github.com/wesleyscholl/discussion-auto-responder/blob/main/src/__tests__/index.test.ts)   [](https://gist.github.com/wesleyscholl/10f0b77400703c4a65f38434106adf2d) [](https://github.com/marketplace/actions/discussion-auto-responder)   [](https://github.com/prettier/prettier) [](https://github.com/prettier/prettier)        [](https://raw.githubusercontent.com/wesleyscholl/discussion-auto-responder/main/LICENSE)
## About
Discussion Autoresponder allows you to automatically create comments on new GitHub Discussions with a GitHub Action. This could be used to post a welcome comment, a message for responding back to new discussion topics, and other use cases.
## Usage
In your workflow, to create a new discussion autoresponder for new discussion topics, include a step like this:
```yaml
- name: Run discussion-auto-responder
uses: wesleyscholl/[email protected]
id: autoresponder-comment
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" # Optional, if you wish you can use: "${{ secrets. }}"
comment_body: "This comment was generated by the Discussion Autoresponder GitHub Action." # Also optional, this is the default message.
delay_milliseconds: 5000 # Optional to delay a comment after newly posted discussion. Written in milliseconds (ms), default 5000 ms = 5 seconds.
```
**To function as intended, ensure you have the following in your workflow:**
```yaml
on:
discussion:
types: [created]
```
## Requirements
To run this action, the Action Workflow permissions require read and write permissions in the repository for all scopes.
To configure this, go to:
- Repository Settings
- Actions
- Generally
- Workflow Permissions
- Then select: "Read and write permissions - Workflows have read and write permissions in the repository for all scopes."
- Finally click the save button.
## Config Screenshot
## Action Inputs
| Name | Description | Requried? | Default |
| --- | --- | --- | --- |
| `GITHUB_TOKEN` | A GitHub PAT is required, but the default is sufficient for public repos. For private repos, ensure you create a PAT that has `discussion: write` and `repo: write`, then store it as an action secret for usage within the workflow. See more details about tokens here. [PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). | **No** | `${{ secrets.GITHUB_TOKEN }}` |
| `comment_body` | The contents of the autoresponder comment in string format. | **No** | `"This comment was generated by the Discussion Autoresponder GitHub Action."` |
| `delay_milliseconds` | Amount of delay time before the autoresponder comment is posted. Written in milliseconds (ms). | **No** | `5000` |
## Action Outputs
| Name | Description | How To Access |
| --- | --- | --- |
| `discussionId` | The node id of the discussion where the autoresponder comment was posted. | `${{ steps..outputs.discussionId }}` |
| `commentId` | The comment id posted in the discussion. | `${{ steps..outputs.commentId }}` |
| `commentBody` | The body of the comment posted. | `${{ steps..outputs.commentBody }}` |
| `clientMutationId` | The unique GraphQL client id. | `${{ steps..outputs.clientMutationId }}` |
#### Example Usage To Access Outputs
```yml
- name: Show Output
run: |
echo "discussionId = ${{ steps.autorespond.outputs.discussionId }}"
echo "commentId = ${{ steps.autorespond.outputs.commentId }}"
echo "commentBody = ${{ steps.autorespond.outputs.commentBody }}"
echo "clientMutationId = ${{ steps.autorespond.outputs.clientMutationId }}"
```
## Example
Example [workflow](https://github.com/wesleyscholl/discussion-auto-responder/blob/main/.github/workflows/respond.yml) can be found here.
## Credits
- [Create and Publish a GitHub Action in Typescript - Leonardo Montini](https://leonardomontini.dev/typescript-github-action)
- [Coverage Badge with GitHub Actions - FINALLY!](https://dev.to/thejaredwilcurt/coverage-badge-with-github-actions-finally-59fa)
### Inspired by:
- [peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment)
- [abirismyname/create-discussion](https://github.com/abirismyname/create-discussion)