https://github.com/kentaro-m/qr-code-commenter-action

:camera: A GitHub Action that posts a QR code to a pull request comment.
https://github.com/kentaro-m/qr-code-commenter-action

actions code-review github my-portfolio pull-request qrcode qrcode-generator utility

Last synced: 10 days ago
JSON representation

:camera: A GitHub Action that posts a QR code to a pull request comment.

• Host: GitHub
• URL: https://github.com/kentaro-m/qr-code-commenter-action
• Owner: kentaro-m
• License: mit
• Created: 2020-03-14T10:34:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-13T04:11:41.000Z (over 2 years ago)
• Last Synced: 2024-05-21T11:40:01.810Z (6 months ago)
• Topics: actions, code-review, github, my-portfolio, pull-request, qrcode, qrcode-generator, utility
• Language: TypeScript
• Homepage:
• Size: 1.01 MB
• Stars: 4
• Watchers: 2
• Forks: 9
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# QR Code Commenter

A GitHub Action that posts a QR code to a pull request comment.

![posts a QR code to a pull request comment.](usage.png)

## :arrow_forward: Usage

```yml

uses: kentaro-m/[email protected]

with:

  repo-token: "${{ secrets.GITHUB_TOKEN }}"

  content: https://blog.kentarom.com/

  comment: |

    :lock: This is a QR code for access to the preview website.

    :iphone: Scan a code with your device.

    {qrcode}

```

### Set up required parameters

Need to contain the required parameters on the workflow file.

- `repo-token` Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`

- `content` The content to encode to QR code. Must be string.

- `comment` The body for comment to post to a pull request comment. Must be contained `{qrcode}` placeholder and placed it to a new line.

### Use a text outputted from the other action as input

You can use a text outputted from the other action as input.

Check the following page about the detail of `outputs` syntax: [Metadata syntax for GitHub Actions - GitHub Help](https://help.github.com/en/actions/building-actions/metadata-syntax-for-github-actions#outputs)

```yml

uses: kentaro-m/[email protected]

with:

  repo-token: "${{ secrets.GITHUB_TOKEN }}"

  # Use a text outputted from the other action

  content: "${{ steps.deploy.outputs.preview_url }}"

  comment: |

    :lock: This is a QR code for access to the preview website.

    :iphone: Scan a code with your device.

    {qrcode}

```

## :memo: Licence

MIT