Skip to content

Add Slack forum link to all user-facing communications - #651

Merged
majamassarini merged 2 commits into
packit:mainfrom
majamassarini:add-slack-forum-link
Jul 3, 2026
Merged

Add Slack forum link to all user-facing communications#651
majamassarini merged 2 commits into
packit:mainfrom
majamassarini:add-slack-forum-link

Conversation

@majamassarini

Copy link
Copy Markdown
Member

Summary

This PR adds the Slack forum link to all user-facing communications from Ymir agents, making it easier for users to provide feedback and report issues through the preferred channel.

Changes

1. Jira Comments (ymir/agents/constants.py)

  • Updated AGENT_WARNING to include a prominent call-out with the Slack forum link
  • Added message: "where your feedback will be more visible than pinging us on individual issues"
  • This appears in all Jira comments from all agents (Triage, Backport, Rebase, Rebuild, etc.) because they all use tasks.comment_in_jira() which uses JIRA_COMMENT_TEMPLATE

2. Merge Request Descriptions (ymir/agents/constants.py)

  • Updated mr_description_footer() to make the Slack channel a clickable link
  • Enhanced the "Feedback Welcome" section to encourage forum usage and emphasize visibility
  • Changed from "does not meet your expectations" to "suggestions or complaints" for clarity

3. README.md

  • Updated Contact & Feedback section with the same improvements
  • Made Slack forum link clickable and prominent

Impact

The Slack forum link (https://redhat.enterprise.slack.com/archives/C095699FLMR) is now visible and clickable in:

  • All Jira comments posted by any Ymir agent
  • All GitLab merge request descriptions
  • The project README

This will help direct user feedback to the forum where it's more visible and can be addressed more effectively by the team.

Testing

  • ✅ Pre-commit hooks passed (trailing whitespace, line length checks)
  • ✅ All changed files validated

🤖 Generated with Claude Code

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README and agent constants to provide direct links to the Slack forum for suggestions and complaints, replacing plain text channel references. The review feedback correctly points out that the AGENT_WARNING constant is used in Jira comments, which require Jira wiki markup rather than standard Markdown to render correctly, and provides a suggestion to fix the formatting.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread ymir/agents/constants.py Outdated
@qodo-for-packit

Copy link
Copy Markdown

PR Summary by Qodo

Add Slack forum link to Jira/MR templates and README

✨ Enhancement 📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Add a clickable Slack forum link to the standard Jira comment warning text.
• Update merge request description footer to direct feedback to the Slack forum.
• Align README contact guidance with the same Slack forum messaging.
Diagram

graph TD
  A["Ymir agents"] --> B["Jira comment template"] --> C["Jira comments"] --> G["Users"]
  A --> D["MR footer helper"] --> E["GitLab MR description"] --> G
  F["README contact section"] --> G
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Centralize Slack forum URL/text constants in one place
  • ➕ Avoids duplicated URL/message fragments across multiple templates
  • ➕ Reduces risk of future drift if the channel/URL changes
  • ➕ Improves readability of long string literals in templates
  • ➖ Slightly more indirection for simple static text
  • ➖ README still requires manual update since it is user documentation
2. Make the forum link configurable (env/config) and inject at runtime
  • ➕ Allows changing the destination without code changes
  • ➕ Useful if different deployments need different feedback channels
  • ➖ Adds configuration surface area and failure modes
  • ➖ Probably unnecessary for a single stable channel link

Recommendation: The PR’s approach (hardcoding a clear, clickable forum link in each user-facing surface) is appropriate for reliability and visibility. Consider a small follow-up to define shared constants for the Slack forum URL/label within ymir/agents/constants.py to reduce duplication between the Jira warning and MR footer.

Files changed (2) +18 / -6

Enhancement (1) +14 / -5
constants.pyAdd Slack forum callout to Jira warning and MR footer +14/-5

Add Slack forum callout to Jira warning and MR footer

• Extends the shared Jira warning text to include a prominent Slack forum link and guidance to post feedback there. Updates the merge request footer contact line and the feedback section to reference the same clickable forum link and refined wording.

ymir/agents/constants.py

Documentation (1) +4 / -1
README.mdMake Slack forum link clickable and expand feedback guidance +4/-1

Make Slack forum link clickable and expand feedback guidance

• Replaces the plain Slack channel reference with a clickable Slack forum link. Adds a short note directing suggestions/complaints to the forum for better visibility.

README.md

@qodo-for-packit

qodo-for-packit Bot commented Jul 2, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 7 rules

Grey Divider


Action required

1. Jira link uses Markdown ✓ Resolved 🐞 Bug ≡ Correctness
Description
AGENT_WARNING adds the Slack forum using Markdown (**bold**, [text](url)), but Jira comments
are posted as a raw string body and other Jira-facing content in this repo uses Jira wiki link
syntax, so the Slack link/bold will likely render literally (not clickable) in Jira comments.
Code

ymir/agents/constants.py[R10-12]

+    "💬 **Have suggestions or complaints?** "
+    "Please reach out to us on the [Slack forum #forum-ymir-package-automation]"
+    "(https://redhat.enterprise.slack.com/archives/C095699FLMR) "
Relevance

⭐⭐⭐ High

Team uses Jira wiki links in Jira comments (e.g., PR #646 adds [text|url]); Markdown likely
undesirable.

PR-#646
PR-#106

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The Jira comment template always appends AGENT_WARNING, and Jira comments are posted as a plain
string; meanwhile other Jira-targeted strings in this repo use Jira wiki link syntax ([text|url]),
indicating Markdown-style links won’t render as intended in Jira.

ymir/agents/constants.py[5-18]
ymir/agents/tasks.py[251-272]
ymir/tools/privileged/jira.py[346-370]
ymir/agents/utilities/baseline_tests.py[62-65]
ymir/agents/issue_verification_agent.py[374-379]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
Jira comments are constructed with `JIRA_COMMENT_TEMPLATE` (which embeds `AGENT_WARNING`) and sent via the Jira REST API with a plain string body. The updated `AGENT_WARNING` uses Markdown formatting (`**...**` and `[text](url)`), but existing Jira comment formatting in this repo uses Jira wiki markup (e.g., `[text|url]`), so the Slack forum link won’t be clickable in Jira.

### Issue Context
- `JIRA_COMMENT_TEMPLATE` injects `AGENT_WARNING` into every Jira comment.
- Jira comment posting uses a string `body` (not GitLab-flavored Markdown rendering).

### Fix Focus Areas
- ymir/agents/constants.py[5-18]

### Suggested change
Replace Markdown formatting in `AGENT_WARNING` with Jira wiki markup, e.g.:
- Bold: `*Have suggestions or complaints?*` (instead of `**...**`)
- Link: `[Slack forum #forum-ymir-package-automation|https://redhat.enterprise.slack.com/archives/C095699FLMR]`

(Keep the GitLab MR footer and README in Markdown; only the Jira warning text needs wiki/plain-text-safe formatting.)

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. Skills docs warning drift ✓ Resolved 🐞 Bug ⚙ Maintainability
Description
AGENT_WARNING was expanded with a Slack-forum callout, but agents_as_skills/*/SKILL.md still
documents the old Jira comment warning text without the Slack forum link. This creates inconsistent
user-facing messaging and means users following the skills docs won’t include the new forum
guidance.
Code

ymir/agents/constants.py[R9-13]

+    "at https://docs.google.com/document/d/1zKeJQtIlGkgQ7QoEVFxz4dLVEjqB74_E3tW0_wCo6YM/edit?usp=sharing\n\n"
+    "💬 *Have suggestions or complaints?* "
+    "Please reach out to us on the [Slack forum #forum-ymir-package-automation|"
+    "https://redhat.enterprise.slack.com/archives/C095699FLMR] "
+    "where your feedback will be more visible than pinging us on individual issues."
Relevance

⭐⭐⭐ High

Team has made consistency fixes in user-facing comms/docs before (Slack channel rename applied
across code+README in PR #419).

PR-#419

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The code now emits a longer AGENT_WARNING with the Slack forum callout, while the skill
documentation still describes posting Jira comments with the older warning text, proving the
documentation is out of sync with current behavior/intent.

ymir/agents/constants.py[5-13]
agents_as_skills/triage/SKILL.md[898-901]
agents_as_skills/backport/SKILL.md[297-305]
agents_as_skills/rebase/SKILL.md[247-255]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`AGENT_WARNING` now includes the Slack forum guidance, but multiple `agents_as_skills/*/SKILL.md` documents still show the pre-change warning/disclaimer text for Jira comments.

## Issue Context
The skills markdown files are user-facing instructions/templates; keeping them aligned with `AGENT_WARNING` avoids confusing drift and ensures the “Slack forum link everywhere” goal is actually reflected in skill-driven usage.

## Fix Focus Areas
- ymir/agents/constants.py[5-13]
- agents_as_skills/triage/SKILL.md[898-901]
- agents_as_skills/backport/SKILL.md[297-305]
- agents_as_skills/rebase/SKILL.md[247-255]

## Suggested fix
- Update the Jira comment formatting examples in the SKILL.md files to include the same Slack forum callout (and Jira wiki link syntax) as `AGENT_WARNING`.
- Optionally, reduce future drift by referencing a single canonical snippet (e.g., include the warning text from a shared doc section, or add a note that the warning is sourced from `ymir/agents/constants.py:AGENT_WARNING`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Informational

3. Enterprise Slack link public 🐞 Bug ⚙ Maintainability
Description
mr_description_footer() and the README now embed a direct redhat.enterprise.slack.com URL, which
will be published in every Ymir-opened GitLab merge request description and in repo documentation.
If those surfaces are visible to non-Red-Hat users (e.g., gitlab.com/redhat/centos-stream), the link
will be unusable and the “Questions/Feedback” section becomes less actionable.
Code

ymir/agents/constants.py[R60-72]

+        "**Contact:** redhat-ymir-agent@redhat.com | "
+        "**Slack Forum:** [#forum-ymir-package-automation]"
+        "(https://redhat.enterprise.slack.com/archives/C095699FLMR) | "
        "**Report AI Issues:** [Jira](https://issues.redhat.com/) "
        "(project: Packit, component: jotnar) "
        "or [GitHub](https://github.com/packit/ai-workflows/issues)\n"
        "\n"
        "### 💡 Feedback Welcome\n"
        "\n"
-        "If the quality of this MR does not meet your expectations or you have suggestions "
-        "for improvement, please reach out to us. Your feedback helps us continuously "
-        "improve Ymir's capabilities and deliver better results.\n"
+        "If you have suggestions or complaints about the quality of this MR, "
+        "please reach out to us on the [Slack forum]"
+        "(https://redhat.enterprise.slack.com/archives/C095699FLMR) "
+        "where your feedback will be more visible than pinging us on individual issues. "
Relevance

⭐ Low

Repo already includes internal-only details in public README (e.g., OpenShift namespace/LDAP in PR
#33); not enforced.

PR-#33
PR-#419

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The MR footer includes a direct enterprise Slack URL, and Ymir uses that footer when opening merge
requests; the same URL is also added to README, increasing the chance it’s shown to users who can’t
access Red Hat internal Slack.

ymir/agents/constants.py[60-72]
ymir/agents/constants.py[53-55]
ymir/agents/tasks.py[198-236]
README.md[113-121]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`mr_description_footer()` and README now include a direct `redhat.enterprise.slack.com` URL. In environments where generated MRs/docs are public-facing, this link is not accessible to external readers and reduces the usefulness of the contact/feedback callout.

## Issue Context
Ymir opens merge requests via `open_merge_request`, and `mr_description_footer()` is appended to MR descriptions by multiple agents; the footer also explicitly references `gitlab.com/redhat/centos-stream/...`, which is typically a public GitLab host.

## Fix Focus Areas
- ymir/agents/constants.py[60-72]
- README.md[113-121]

## Suggested fix
- Either:
 - Add explicit wording like “(Red Hat internal Slack)” next to the Slack forum link, and/or
 - Prefer a universally accessible feedback path (e.g., GitHub/Jira link) first, keeping Slack as an optional/internal channel.
- If MRs are guaranteed internal-only, document that assumption (or gate the Slack URL behind an environment/config flag so public deployments don’t emit it).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment thread ymir/agents/constants.py Outdated
Update Jira comments, MR descriptions, and README to include a clickable
link to the Slack forum (#forum-ymir-package-automation) and emphasize
that feedback posted there is more visible than on individual issues.

Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@majamassarini
majamassarini force-pushed the add-slack-forum-link branch from 1e66d10 to 4efc66e Compare July 3, 2026 07:10
@majamassarini

Copy link
Copy Markdown
Member Author

/agentic_review

Comment thread ymir/agents/constants.py Outdated
@qodo-for-packit

Copy link
Copy Markdown

Code review by qodo was updated up to the latest commit 4efc66e

@TomasKorbar
TomasKorbar self-requested a review July 3, 2026 08:16
TomasKorbar
TomasKorbar previously approved these changes Jul 3, 2026

@TomasKorbar TomasKorbar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread agents_as_skills/backport/SKILL.md Outdated

Warning: This is an AI-Generated contribution and may contain mistakes.
Please carefully review the contributions made by AI agents.
You can learn more about the Ymir project at https://docs.google.com/document/d/1zKeJQtIlGkgQ7QoEVFxz4dLVEjqB74_E3tW0_wCo6YM/edit?usp=sharing

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer linking directly our docs page https://ymir.pages.redhat.com/

Sync the SKILL.md files with the updated AGENT_WARNING from constants.py
to ensure skill-driven usage also includes the Slack forum guidance.

Updated skills:
- agents_as_skills/triage/SKILL.md
- agents_as_skills/backport/SKILL.md
- agents_as_skills/rebase/SKILL.md

All now include the same Slack forum callout that appears in the
production agent Jira comments, using Jira wiki link syntax.

Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com>

@lbarcziova lbarcziova left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

@majamassarini
majamassarini merged commit 65774d9 into packit:main Jul 3, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants