PR Comment Trigger Action

• Inputs
  • Permissions
• Outputs
• Examples
• Tags
• Support
• Contributing

Caution

This action is currently under development and not ready for use.
Please check back soon...

This actions triggers on PR comments, and triggers workflows based on the value of the comment (the command). Commands can be configured in YAML or passed as a string in the Workflow.

Inputs

Input	Req.	Default Value	Input Description
file	-	.github/pr-comment.yaml	Location of config file.
yaml	-	-	Inline YAML config.
json	-	-	Inline JSON config.
token	-	github.token	For use with a PAT

At least one config input is required!
If the file is not found the Default Config will be used (TBD).

👀 View Example Job Summary

---

Coming Soon...

---

Coming Soon...

- name: 'PR Comment Trigger Action'
  uses: cssnr/pr-comment-trigger-action@master
  with:
    file: .github/pr-comment.yaml

Permissions

This action requires the following permissions:

permissions:
  pull-requests: write

Permissions documentation for Workflows and Actions.

Outputs

Output	Description
id	Workflow ID

- name: 'PR Comment Trigger Action'
  id: test
  uses: cssnr/pr-comment-trigger-action@master

- name: 'Echo Output'
  run: |
    echo "id: '${{ steps.test.outputs.id }}'"

Examples

💡 Click on an example heading to expand or collapse the example.

name: 'Test'

on:
  workflow_dispatch:
  push:

jobs:
  test:
    name: 'Test'
    runs-on: ubuntu-latest
    timeout-minutes: 5
    permissions:
      contents: write

    steps:
      - name: 'Checkout'
        uses: actions/checkout@v4

      - name: 'PR Comment Trigger Action'
        id: test
        uses: cssnr/pr-comment-trigger-action@master

      - name: 'Echo Outputs'
        run: |
          echo "id: '${{ steps.test.outputs.id }}'"

For more examples, you can check out other projects using this action:
https://github.com/cssnr/pr-comment-trigger-action/network/dependents

Tags

The following rolling tags are maintained.

Version Tag	Rolling	Bugs	Feat.	Name	Target	Example
	✅	✅	✅	Major	vN.x.x	vN
	✅	✅	❌	Minor	vN.N.x	vN.N
	❌	❌	❌	Micro	vN.N.N	vN.N.N

You can view the release notes for each version on the releases page.

The Major tag is recommended. It is the most up-to-date and always backwards compatible. Breaking changes would result in a Major version bump. At a minimum you should use a Minor tag.

Support

For general help or to request a feature, see:

• Q&A Discussion: https://github.com/cssnr/pr-comment-trigger-action/discussions/categories/q-a
• Request a Feature: https://github.com/cssnr/pr-comment-trigger-action/discussions/categories/feature-requests

If you are experiencing an issue/bug or getting unexpected results, you can:

• Report an Issue: https://github.com/cssnr/pr-comment-trigger-action/issues
• Chat with us on Discord: https://discord.gg/wXy6m2X8wY
• Provide General Feedback: https://cssnr.github.io/feedback/

For more information, see the CSSNR SUPPORT.md.

Contributing

Currently, the best way to contribute to this project is to star this project on GitHub.

For more information, see the CSSNR CONTRIBUTING.md.

Additionally, you can support other GitHub Actions I have published:

• Stack Deploy Action
• Portainer Stack Deploy
• VirusTotal Action
• Mirror Repository Action
• Update Version Tags Action
• Update JSON Value Action
• Parse Issue Form Action
• Cloudflare Purge Cache Action
• Mozilla Addon Update Action
• Docker Tags Action
• Package Changelog Action
• NPM Outdated Check Action

For a full list of current projects to support visit: https://cssnr.github.io/