Comment on Pull Request workflow (Mrinank-Bhowmick/python-beginner-projects)

The Comment on Pull Request workflow from Mrinank-Bhowmick/python-beginner-projects, explained and optimized by Latchkey.

CI health: A - excellent

Point runs-on at Latchkey and get job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: Mrinank-Bhowmick/python-beginner-projects.github/workflows/comment_on_pr.ymlLicense MITView source

What it does

This is the Comment on Pull Request workflow from the Mrinank-Bhowmick/python-beginner-projects repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: Comment on Pull Request

on:
  pull_request_target:
    types: [opened]

jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/github-script@v6
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: 'Greetings! This is an automated message from GitHub Actions. :robot:\nYour pull request has been received and is awaiting for a review by the repository owner or a maintainer. This may take some time, so please be patient.\nWhile you wait, you can continue to work on other issues or pull requests, or explore the project further. Or you can simply relax and enjoy your day.\nThank you for your contribution to this project! You are awesome! :star:'
            })

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: Comment on Pull Request
 
on:
  pull_request_target:
    types: [opened]
 
jobs:
  comment:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/github-script@v6
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: 'Greetings! This is an automated message from GitHub Actions. :robot:\nYour pull request has been received and is awaiting for a review by the repository owner or a maintainer. This may take some time, so please be patient.\nWhile you wait, you can continue to work on other issues or pull requests, or explore the project further. Or you can simply relax and enjoy your day.\nThank you for your contribution to this project! You are awesome! :star:'
            })

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Add a job timeout so a hung step cannot burn hours of runner time.

This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/github-script