Skip to content

Commit 3a064fe

Browse files
authored
Fix details in README (#274)
* Fix CI badges * Mark steps as optional and project_key as mandatory
1 parent 0da6d79 commit 3a064fe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[![Build Docker image](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/build-image.yaml/badge.svg)](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/build-image.yaml)
2-
[![Run tests](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/test-build.yaml/badge.svg)](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/test-build.yaml)
1+
[![Build Docker image](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/build-publish.yaml/badge.svg)](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/build-publish.yaml)
2+
[![Run tests](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/test.yaml/badge.svg)](https://github.com/mozilla/jira-bugzilla-integration/actions/workflows/test.yaml)
33
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
44

55
# Jira Bugzilla Integration (JBI)
@@ -76,10 +76,10 @@ to the Bugzilla ticket on the Jira issue.
7676

7777
**Parameters**
7878

79-
- `jira_project_key`
79+
- `jira_project_key` (**mandatory**)
8080
- string
8181
- The Jira project identifier
82-
- `steps`
82+
- `steps` (optional)
8383
- mapping [str, list[str]]
8484
- If defined, the specified steps are executed. The group of steps listed under `new` are executed when a Bugzilla event occurs on a ticket that is unknown to Jira. The steps under `existing`, when the Bugzilla ticket is already linked to a Jira issue. The steps under `comment` when a comment is posted on a linked Bugzilla ticket.
8585
If one of these groups is not specified, the default steps will be used.

0 commit comments

Comments
 (0)