💬 Comment on Issue from Commit - GitHub Action

A GitHub Action that helps your team communicate and collaborate before you open a pull request.

How It Works

This GitHub Action runs when an push event webhook is fired in your GitHub repo. The action checks for a #comment your message goes here in commit messages and added them as a comment on the related issue if the branch name includes the issue number in the #issueNumber-something-something format. You can also notify other people by @mentioning their GitHub username in the comment #comment your message goes here and notifies @person.

Since GitHub Actions currently only support actions within the same repo, this action currently only supports comments in on issues and commit in the same repo.

Examples

Example of issue before work has started:

Example of creating a branch referencing issue #24 and adding a comment in the commit message:

Example of issue with comment from commit:

Installation

To use this GitHub Action, you must have access to GitHub Actions. GitHub Actions are currently only available in private beta (you must apply for access) and only work in private repos.

To setup this action:

1. Create a .github/worksflows/main.yml in your GitHub repo (more info).
2. Add the following code to the main.yml file and commit it to the repo's master branch.

name: Commit Issue Commenter

on: push

jobs:
  checkCommit:
    name: Comment From Commit
    runs-on: ubuntu-latest
    steps:
      - uses: tinkurlab/commit-issue-commenter-action@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3. Whenever you push changes to GitHub, the action will run!

Contributing

If you have suggestions for how this GitHub Action could be improved, or want to report a bug, open an issue! Or pull request! We'd love all and any contributions. For more, check out the Contributing Guide.

License

ISC © 2022 Adam Zolyak adam@tinkurlab.com (www.tinkurlab.com)