Skip to content

Commit

Permalink
Improve description of the new field in README
Browse files Browse the repository at this point in the history
  • Loading branch information
hector-cao committed Jun 10, 2024
1 parent d5fbade commit 31819c1
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,19 @@ settings:
label_mapping:
enhancement: Story

# (Optional) JIRA issue's summary customization
# Allow to define the JIRA issue's summary and eventually format it with the values
# of the GH issue variable.
# (Optional) JIRA issue's summary
# This field can be used to customize the JIRA issue's summary (title)
# The value of the field will be an input to the python [`format()`](https://www.w3schools.com/python/ref_string_format.asp) method
# to generate the JIRA summary.
# The GH issue variable will be captured in the `format` method to allow users to customize
# the title with the values of the GH issue.
# See GH issue definition : https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28
#
# Examples:
# to use fixed title "github issue": "github issue"
# to use GH issue title: "{issue.title}"
# to add prefix "[GitHub]" : "[GitHub] {issue.title}"
# to add user in the title (between square brackets): "[{issue.user.login}] {issue.title}"
# to use fixed title "github issue": `"github issue"`
# to use GH issue title: `"{issue.title}"`
# to add prefix "[GitHub]" : `"[GitHub] {issue.title}"`
# to add user in the title (between square brackets): `"[{issue.user.login}] {issue.title}"`
summary: "{issue.title}"
```
Expand Down

0 comments on commit 31819c1

Please sign in to comment.