Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing configuration documentation #46

Merged
merged 2 commits into from
Nov 1, 2023
Merged

Add missing configuration documentation #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
593e800
doc: add missing configuration documentation
jamacku Nov 1, 2023
a5b8149
build: update `dist/` files
jamacku Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 44 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@

The purpose of this action is to offer reliable validator Red Hat trackers like [Bugzilla](https://bugzilla.redhat.com/) and [JIRA](https://issues.redhat.com).

## How does it work

> TBD

## Features

* product, component and flags validation
Expand Down Expand Up @@ -146,16 +142,15 @@ jobs:
pr-metadata: ${{ needs.download-metadata.outputs.pr-metadata }}
product: Red Hat Enterprise Linux 9
component: systemd
bugzilla-tracker:
tracker: ${{ fromJSON(needs.commit-linter.outputs.validated-pr-metadata).validation.tracker.id }}
tracker-type: ${{ fromJSON(needs.commit-linter.outputs.validated-pr-metadata).validation.tracker.type }}
bugzilla-instance: https://bugzilla.stage.redhat.com
bugzilla-api-token: ${{ secrets.BUGZILLA_API_TOKEN }}
jira-instance: https://issues.redhat.com
jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
token: ${{ secrets.GITHUB_TOKEN }}
```

### Real-life examples

> ...

## Configuration options

Action currently accepts the following options:
Expand Down Expand Up @@ -191,7 +186,7 @@ Pull Request metadata has the following format: [metadata format](https://github

### config-path

Path to configuration file. Configuration file format is described in: [Configuration section](#Configuration).
Path to configuration file. Configuration file format is described in: [Configuration section](#configuration).

* default value: `.github/tracker-validator.yml`
* requirements: `optional`
Expand Down Expand Up @@ -262,15 +257,50 @@ permissions:

## Configuration

### product
```yml
labels:
missing-tracker: tracker/missing
invalid-product: tracker/invalid-product
invalid-component: tracker/invalid-component
unapproved: tracker/unapproved
products: []
```

### `labels` keyword

Allows you to set custom labels for certain conditions. When no value is provided, default value is used.

#### `missing-tracker` keyword

Name of the label which will be set when tracker is missing.

* default value: `tracker/missing`

#### `invalid-product` keyword

Name of the label which will be set when tracker is targeting invalid product.

* default value: `tracker/invalid-product`

#### `invalid-component` keyword

Name of the label which will be set when tracker is targeting invalid component.

* default value: `tracker/invalid-component`

#### `unapproved` keyword

Name of the label which will be set when tracker is not approved.

* default value: `tracker/unapproved`

### `product` keyword

Product name is used for validation if provided tracker is targeting the expected product. For example, for Bugzilla: `product: Red Hat Enterprise Linux 9`. If product is not provided, validation will be skipped.

* default value: `undefined`
* requirements: `optional`

> ...

## Limitations

> ...
* Status checks from Pull Request Validator are randomly assigned to check suites, GitHub API for check suites doesn't provide a way to assign a check to a specific suite.
Loading