Adjust examples of PACKIT_RESOLVED_BUGS usage (#762)

Adjust examples of PACKIT_RESOLVED_BUGS usage Reviewed-by: František Lachman <flachman@redhat.com>
packit · Oct 17, 2023 · 6e3ab5f · 6e3ab5f
2 parents 445f01f + 5744971
commit 6e3ab5f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/docs/configuration/actions.md b/docs/configuration/actions.md
@@ -153,7 +153,7 @@ This separator is exposed as an environment variable `PACKIT_DEBUG_DIVIDER`.
     ---%<--- snip ---%<--- here ---%<---
     Rebase to new upstream release 0.42.69
 
-    Resolves rhbz#124
+    - Resolves rhbz#124
 
 This output can be produced by the following config:
 ```yaml
@@ -162,7 +162,7 @@ actions:
     - echo 'debug output'
     - bash -c 'echo ${PACKIT_DEBUG_DIVIDER}'
     - bash -c 'echo -e "Rebase to new upstream release ${PACKIT_PROJECT_VERSION}\n"'
-    - bash -c 'echo -e "Resolves ${PACKIT_RESOLVED_BUGS}\n"'
+    - bash -c '[ -z "$PACKIT_RESOLVED_BUGS" ] || echo ${PACKIT_RESOLVED_BUGS} | tr " " "\n" | sed "s/^/- Resolves /"'
 ```
 
 </details>

diff --git a/docs/configuration/downstream/pull_from_upstream.md b/docs/configuration/downstream/pull_from_upstream.md
@@ -9,7 +9,7 @@ A dist-git only job that opens a new dist-git pull request in
 src.fedoraproject.org when a new upstream release happens using a notification
 from [release-monitoring.org](https://release-monitoring.org/). Upstream Release Monitoring creates a Bugzilla
 for the new upstream release and this Bugzilla is by default referenced in the dist-git changelog as
-`- Resolves rhbz#xz` and `Resolves rhbz#xz` in the commit message. This behaviour can be customized
+`- Resolves rhbz#xz` and `- Resolves rhbz#xz` in the commit message. This behaviour can be customized
 using [actions](/docs/configuration/actions#syncing-the-release).
 
 This job utilizes the same logic as `propose_downstream` with the only

diff --git a/docs/fedora-releases-guide.md b/docs/fedora-releases-guide.md
@@ -237,12 +237,14 @@ for overriding the Packit default behaviour, for example:
   - for the changelog entry generation, if you do not want the default `git log` output, you can use your own command(s):
 
         changelog-entry:
-          - bash -c 'echo "- New release ${PACKIT_PROJECT_VERSION} (${PACKIT_RESOLVED_BUGS})"'
+          - bash -c 'echo "- New release ${PACKIT_PROJECT_VERSION}"'
+          - bash -c '[ -z "$PACKIT_RESOLVED_BUGS" ] || echo ${PACKIT_RESOLVED_BUGS} | tr " " "\n" | sed "s/^/- Resolves /"'
+
   - for a custom commit message for commit created by Packit:
 
         commit-message:
           - bash -c 'echo -e "Rebase to new upstream release ${PACKIT_PROJECT_VERSION}\n"'
-          - bash -c 'echo -e "Resolves ${PACKIT_RESOLVED_BUGS}\n"'
+          - bash -c '[ -z "$PACKIT_RESOLVED_BUGS" ] || echo ${PACKIT_RESOLVED_BUGS} | tr " " "\n" | sed "s/^/- Resolves /"'
 
 
 You can check all the job runs with details and logs in [this view](https://dashboard.packit.dev/jobs/pull-from-upstreams).