A GitHub app to report failed workflow job actions and notify pull request creator with custom report message for the failed workflow job.

Overview
Workflow Reporter Logo

Workflow Reporter

GitHub GitHub package.json version GitHub package.json dependency version (prod)
GitHub language count GitHub top language GitHub last commit GitHub issues GitHub pull requests
GitHub Sponsors GitHub all releases GitHub contributors GitHub Repo stars

A GitHub App built with Probot that reports failed workflow job actions and notify the pull request creator with custom report message for the failed workflow job step.

Purpose

Do you have hard time notifying the pull request creator about what went wrong with the workflow job step and how to fix it? If yes, workflow reporter is there for you to automate this process.

Workflow Reporter will automatically tag the pull request creator and notify about the failed workflow job step with your custom report message for the failed job step.

Demo

Workflow Reporter Github app

Workflow reporter also provides necessary information about the workflow, job and the step on which the github action failed.

Setup your workflow reporter now!

Setup

Install the app on GitHub repository from GitHub Marketplace.

Add a .github/workflow-reporter.yml file to your repository and then run the bot against it.

If the workflow-reporter file is empty or doesn't exist, the bot will not run.

# Receive the workflow stats
workflowStat: true

# Receive the workflow job stats
jobStat: true

# Salutation for the user
# Eg. Hello @divshekhar, / Hi @divshekhar,
salutation: Hello

# Custom body message
# This will come after salutation
body: The continuous integration workflow has failed. It is requested to look after the issue and create a new PR.

workflows:
  - name: CI
    jobs:
      - name: build
        steps:
          - name: Install Dependencies
            # custom report message when the check check fails on this step
            report: Check if syntax in the dependency file is correct.

          - name: Check Code Formatting
            # custom report message when the check check fails on this step
            report: The code formatting check has failed. Run `flutter format --set-exit-if-changed lib` and remove the formatting issue.

Development Setup

# Install dependencies
npm install

# Run the bot
npm start

Contributing

If you have suggestions for how workflow-reporter could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

Chat

Discord

Join our Discord server to become a part of our developer community!

Social

GitHub followers

Twitter URL

License

ISC © 2022 Divyanshu Shekhar.

You might also like...

Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

Jan 3, 2023

An action intended to run on pull request and post a comment summarizing any changes to DevCycle variables.

An action intended to run on pull request and post a comment summarizing any changes to DevCycle variables.

Overview With this Github action, information on which DevCycle features have been added or removed in a code change will be shown directly on each Pu

Jun 14, 2022

Runs sfdx-scanner on a pull request and generates in-line comments with the findings.

Runs sfdx-scanner on a pull request and generates in-line comments with the findings.

sfdx-scan-pull-request Runs sfdx-scanner on a pull request and generates in-line comments with the findings. Inputs category Categor(ies) of rules to

Jan 7, 2023

Make your first Pull Request on Hacktoberfest 2022. Don't forget to spread love and if you like give us a star

Make your first Pull Request on Hacktoberfest 2022. Don't forget to spread love and if you like give us a star

Hacktoberfest2022 Make your first Pull Request on Hacktoberfest 2022. Don't forget to spread love and if you like give us a star Quality of Pull Reque

Oct 30, 2022

Automatically code review with ktlint result for pull request

Automatically code review with ktlint result for pull request

GitHub Actions - ktlint-auto-review 🚀 Automatically reviewed on Pull Request with ktlint Inspired by ScaCap/action-ktlint but without reviewdog. Gett

Dec 20, 2022

A request library that returns promises, inspired by request

then-request A request library that returns promises and supports both browsers and node.js Installation npm install then-request Usage request(metho

Nov 29, 2022

A custom action for setting GitHub Workflow environment variables with YAML configuration files.

yaml-env-action - A custom action for setting GitHub Workflow environment variables with YAML configuration files. Introduction yaml-env-action is a c

Dec 13, 2022

A Docusaurus website deployed to GitHub Pages using GitHub Actions.

Deploy Docusaurus website to GitHub Pages using GitHub Actions This repository is an example of deploying a Docusaurus website to GitHub Pages using G

Dec 26, 2022

Notify users of your Next.js app when a new deploy is available.

Notify users of your Next.js app when a new deploy is available.

Next.js Deploy Notifications This library lets your users know when you've deployed a new version of your Next.js application. import { hasNewDeploy }

Jan 2, 2023
Releases(v1.0.0)
  • v1.0.0(Jan 30, 2022)

    Initial Release

    • Listen workflow & workflow job event
    • Notify workflow job failure
    • Create issue comment on PR
    • Read config file .github/workflow-reporter.yml
    Source code(tar.gz)
    Source code(zip)
Owner
Divyanshu Shekhar
Student | Developer | Blogger
Divyanshu Shekhar
Re-run failed GitHub Workflow runs on PRs by commenting "/retest".

Retest GitHub Action If you run GitHub Actions Workflows on your PRs, install this action to re-run failed workflow runs for the latest commit by comm

JP Simard 5 Aug 24, 2022
Kuldeep 2 Jun 21, 2022
Create a badge using GitHub Actions and GitHub Workflow CPU time

Generated Badges Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers) Install $ npm i generated-badges -g Command

小弟调调™ 9 Dec 30, 2022
Utility to automatically fill foreign income section of 3-NDFL report based on tax report from Tinkoff broker

Заполнение дохода за пределами РФ в декларации 3-НДФЛ Disclaimer Автор не несет ответственности за корректное заполнение налоговой декларации. Вы запу

Oleg Elifantiev 12 Dec 9, 2022
Learn Basic of Node Express Server and Git & Github by creating Pull Request in this repository.

hacktoberfest-express-server-2022 Learn Basic of Node Express Server and Git & Github by creating Pull Request in this repository. Special Note For Ev

NetScape-Web 3 Oct 6, 2022
Deploy an Architect project from GitHub Actions with keys gathered from aws-actions/configure-aws-credentials

Deploy an Architect project from GitHub Actions with keys gathered from a specific AWS IAM Role federated by an IAM OIDCProvider. CloudFormation to cr

Taylor Beseda 4 Apr 6, 2022
Show a helpful summary of test results in GitHub Actions CI/CD workflow runs

Test Summary Produce an easy-to-read summary of your project's test data as part of your GitHub Actions CI/CD workflow. This helps you understand at-a

Test Summary 293 Jan 2, 2023
The project integrates workflow engine, report engine and organization authority management background, which can be applied to the development of OA, HR, CRM, PM and other systems. With tlv8 IDE, business system development, testing and deployment can be realized quickly.

介绍 项目集成了工作流引擎、报表引擎和组织机构权限管理后台,可以应用于OA、HR、CRM、PM等系统开发。配合使用tlv8 ide可以快速实现业务系统开发、测试、部署。 后台采用Spring MVC架构简单方便,前端使用流行的layui界面美观大方。 采用组件开发技术,提高系统的灵活性和可扩展性;采

Qian Chen 38 Dec 27, 2022
Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

Svante Jonsson IT-Högskolan 3 May 18, 2022
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022