Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
git-branch

GitHub Action

Regression sniffer

v1.0.0

Regression sniffer

git-branch

Regression sniffer

Loyal GitHub action that sniffs out any mentions, follow-up and revert commits of your cherry-picked commits

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Regression sniffer

uses: redhat-plumbers-in-action/[email protected]

Learn more about this action in redhat-plumbers-in-action/regression-sniffer

Choose a version

Regression Sniffer

GitHub Marketplace Lint Code Base Unit Tests CodeQL Check dist/

codecov

TODO: ...

Features

TODO: ...

Usage

TODO: ...

Configuration options

Action currently accepts the following options:

# ...

- uses: redhat-plumbers-in-action/regression-sniffer@v1
  with:
    check-follow-up:  <boolean>
    check-revert:     <boolean>
    pr-metadata:      <pr-metadata.json>
    config-path:      <path to config file>
    token:            <GitHub token or PAT>

# ...

check-follow-up

Check if Pull Request has some follow-up commit related to cherri-picked commits in upstream available.

  • default value: true
  • requirements: optional

check-revert

Check if Pull Request has some cherri-picked commits from upstream that were later reverted.

  • default value: true
  • requirements: optional

pr-metadata

Stringified JSON Pull Request metadata provided by GitHub Action redhat-plumbers-in-action/gather-pull-request-metadata.

Pull Request metadata has the following format: metadata format

  • default value: undefined
  • requirements: required

config-path

Path to configuration file. Configuration file format is described in: Config section.

  • default value: .github/regression-sniffer.yml
  • requirements: optional

token

GitHub token or PAT is used for creating comments on Pull Request.

# required permission
permissions:
  pull-requests: write
  • default value: undefined
  • requirements: required
  • recomended value: secrets.GITHUB_TOKEN

Config

...

Limitations

TODO: ...